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.
Our Roadmap page is a
comprehensive list of tasks we want to do in the future. It is a good place to
start if you want to contribute to
Vizzu. In case you have something else in
mind, that's awesome and we are very interested in hearing about it.
For contributing to the project, it is recommended to use
However, for the documentation we are also using
contribute to this part of the project, you will need
The following steps demonstrate how to set up the development environment on an
22.04 operating system. However, the process can be adapted for other
operating systems as well.
To start using the
ipyvizzu-story development environment, you need to create
a virtual environment and install
pdm within it.
python3.10 -m venv ".venv"
pip install pdm==2.8.0
Once set up, you can install development dependencies:
pdm run deploy
For contributing to the documentation you need to install
The development requirements are installed based on the
package-lock.json files. To update the development requirements, you can use
pdm run lock.
Note: For all available
pdm scripts, run
pdm run --list.
For better development practices, you can set up
hooks in your local
Git repository. The
pre-commit hook will format the code
automatically, and the
pre-push hook will run the CI steps before pushing your
pre-commit install --hook-type pre-commit --hook-type pre-push -c ./tools/ci/.pre-commit-ubuntu.yaml
Note: The provided
.pre-commit-ubuntu.yaml configuration file is tailored
22.04. If you intend to use another operating system, you may
need to create a custom configuration file suitable for that environment.
The CI pipeline includes code formatting checks, code analysis, typing
validation, and unit tests for the
To run the entire CI pipeline, execute the following
pdm run ci
However, if you want to run the CI steps on specific parts of the project, you
can use the following scripts:
You can check the code's formatting using the
pdm run format
If you need to fix any formatting issues, you can use the
pdm run fix-format
If you wish to format specific parts of the project, you can use the following
To perform code analyses, you can use the
pdm run lint
If you need to run code analyses for specific parts of the project, you can
utilize the following scripts:
For type checking, you can use the
pdm run type
If you want to check specific parts of the project, you can use the following
The project is tested using the
unittest testing framework and
tox. To run
the tests, you can use the
pdm run test
To build the documentation, you can use the
pdm run build-docs
You can read the online version at ipyvizzu-story.vizzuhq.com.
ipyvizzu-story is distributed on
pypi. Note: You need to be an
administrator to release the project.
ipyvizzu-story, follow the steps below:
- Increase the version number in
__version__.py. The version bump should be in a separate commit.
- Generate the release notes and publish the new release on Releases.
Note: Publishing a new release will automatically trigger the
which builds, checks, and uploads the
ipyvizzu-story package to
Before making a release, you can build and check the package using the
pdm run release