You can find our open issues in the project's issue tracker. Please let us know if you find any issues or have any feature requests there.
If you want to contribute to the project, your help is very welcome. Just fork the project, make your changes and send us a pull request. You can find the detailed description of how to do this in Github's guide to contributing to projects.
You can initialize the development environment of
dev-py make target to set up your environment.
dev-py make target is going to set up pre-commit and pre-push
hooks into your local git repository. Pre-commit hook is going to format the
black and pre-push hook is going to run the CI steps.
clean make target to clear your environment.
The CI steps check code formatting, run code analyses, check typing and run unit
tests over the
check make target collects the above tasks. Run the
check make target to
run the CI steps.
ipyvizzu-story project is formatted with
format make target to format your code.
check-format target to check code formatting.
ipyvizzu-story project is analysed with
check-lint make target to run code analyses.
ipyvizzu-story project is using type hints.
check-typing make target to run check code typing.
ipyvizzu-story project is tested with
unittest testing framework.
test make target to install
ipyvizzu-story into your virtual
environment and run the tests.
doc make target to build the documentation.
Note: If you modify the documentation, you also need to configure the
make dev-js make check-js make doc
Online version can be read at ipyvizzu-story.vizzuhq.com.
ipyvizzu-story is distributed on
pypi. Note: You need to be an
administrator to release the project.
If you want to release
ipyvizzu-story follow the steps below.
- You should increase the version number in
setup.py. The version bump should be in a separated commit.
- Generate the release notes and publish the new release on Releases.
Note: Publishing a new release will automatically trigger the
workflow which builds, checks and uploads the
ipyvizzu-story package to
You can build and check the package before a release with the