Metadata-Version: 2.1
Name: boar
Version: 0.0.1
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

[![PyPI version](https://badge.fury.io/py/boar.svg)](https://badge.fury.io/py/boar)
![test](https://github.com/alexandreCameron/boar/workflows/test/badge.svg)
[![codecov](https://codecov.io/gh/alexandreCameron/boar/branch/master/graph/badge.svg)](https://codecov.io/gh/alexandreCameron/boar)
[![Documentation Status](https://readthedocs.org/projects/boar/badge/?version=latest)](https://boar.readthedocs.io/en/latest/?badge=latest)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/alexandreCameron/boar/master)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![PyPI - Downloads](https://img.shields.io/pypi/dm/boar)

[![view image on github](./img/boar.jpg)](https://github.com/alexandreCameron/boar/blob/master/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 wild hairy swine with horns...
But if you can prove the value of your idea, why not try it out immediatly with `boar`.

Read more at [./POST.md](https://github.com/alexandreCameron/boar/blob/master/POST.md)

## Installation

Requirements:
[Python 3](https://www.python.org/downloads/)
[pip](https://pip.pypa.io/en/stable/installing/)

The package is available on pypi: [https://pypi.org/project/boar/](https://pypi.org/project/boar/)

To install, execute:

```bash
pip install boar
```

## Practice

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

I would not recommend relying this trick on a long term product.

## Usage

More information at [./USAGE.md](https://github.com/alexandreCameron/boar/blob/master/USAGE.md).

## Reference

### Documentation

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

### Source

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


