In most cases you won't need to build this package locally.
Unless you're doing development work on the kglab library itself, simply install based on the instructions in "Getting Started".
To set up the build environment locally:
pip install -r requirements_build.txt
You will also need to download
for your version of the
Chrome brower, saved as
chromedriver in this directory.
To run type checking:
This project uses
pylint for code checking.
To run code checking:
To run unit tests:
coverage run -m unittest discover
To generate a coverage report and (providing you have the access
token) upload it to the
codecov.io reporting site:
coverage report bash <(curl -s https://codecov.io/bash) -t @.cc_token
Test coverage reports can be viewed at https://codecov.io/gh/DerwenAI/kglab
To generate documentation pages, this project uses:
Source for the documentation is in the
To build the documentation:
./bin/nb_md.sh ./pkg_doc.py docs/ref.md mkdocs build
To preview the generated microsite locally:
Then browse to http://localhost:8000 to review the generated documentation.
To package the generated microsite for deployment on a Flask/WSGI server:
tar cvzf kgl.tgz site/
To update the release on PyPi: