Contributing to ntbk

Setting up the project

Clone the repository and cd into it.

foo@bar:~$ git clone git@github.com:bbeng89/ntbk.git
foo@bar:~$ cd ntbk

Create a virtualenv called "venv" and activate it

foo@bar:~$ python3 -m venv venv
foo@bar:~$ source venv/bin/activate

Install the app for development

foo@bar:~$ python setup.py develop

Build:

foo@bar:~$ python setup.py sdist bdist_wheel

Publish to test.pypi.org

foo@bar:~$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Publish to pypi.org

foo@bar:~$ twine upload dist/*

Tests are written using pytest, pytest-mock, and freeze gun.

Run all tests:

foo@bar:~$ pytest