Development

Your contribution is important but you have to follow same steps.

It will be approved changes or additions with

methods containing title, arguments and returns descriptions
the relative unit tests

Run tests

It is important to test your code before to create a pull request.

cd smltk/
virtualenv .env
source .env/bin/activate
pip3 install --upgrade -r requirements.txt
pip3 install --upgrade -r requirements-dev.txt
python3 -m unittest discover -v
deactivate

Run notebook

If you want to test your code on the usage.ipynb

cd smltk/
docker run --rm -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -v "$PWD":/home/jovyan/ jupyter/datascience-notebook

Build and release

The Makefile exposes targets to build and release the package.

To build and install the package locally:

make localbuild

To upload to Test PyPI and verify the install from there:

make buildtest
make installtest

To upload the official release to PyPI:

make build