Metadata-Version: 2.1
Name: boar
Version: 0.0.0
Summary: Dirty tricks to run python notebooks
Home-page: UNKNOWN
Author: Alexandre Cameron
Author-email: lexcam@hotmail.fr
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# README

Dirty tricks to run python notebooks

![test](https://github.com/alexandreCameron/boar/workflows/test/badge.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
[![made-with-sphinx-doc](https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/)

![boar](img/boar.jpg)

## Purpose

Testing an idea is sometimes more easily done by calling a python notebook in a python code.
It is as dirty, filthy and ugly as a boar...
But if you can prove the value of your idea, why not try it out immediatly with `boar`.

## Practice

I used this trick in CI jobs to make sure tutorials associated to a project stay up-to-date.

I would not recommend to use this code on a long term product.

## Usage

Open [./USAGE.md](./USAGE.md) to view examples on how you can use `boar`.

## Reference

### Source

[https://github.com/alexandreCameron/boar](https://github.com/alexandreCameron/boar)

### [WIP] Installation

`pip install -i https://test.pypi.org/simple/ boar==0.0.0`

[https://test.pypi.org/project/boar/0.0.0/](https://test.pypi.org/project/boar/0.0.0/)

### [WIP] Documentation

[https://boar.readthedocs.io/en/latest/](https://boar.readthedocs.io/en/latest/)


