About

Changes

You can find the complete Chartlets changelog here.

Reporting

If you have suggestions, ideas, feature requests, or if you have identified a malfunction or error, then please post an issue.

Contributions

The Chartlets project welcomes contributions of any form as long as you respect our code of conduct and follow our contribution guide.

If you'd like to submit code or documentation changes, we ask you to provide a pull request (PR) here. For code and configuration changes, your PR must be linked to a corresponding issue.

Development

To set up the Python development environment, with repository root as current working directory:

cd chartlets.py
pip install .[dev,doc]

Testing and Coverage

Chartlets uses pytest for unit-level testing and coverage analysis for its Python code.

cd chartlets.py
pytest --cov=chartlets tests

Coding Style

Chartlets' Python code is formatted by black.

cd chartlets.py
black .

Chartlets' TypeScript code is formatted by prettier.

cd chartlets.js
prettier .

Documentation

Chartlets' documentation is built using the mkdocs tool.

cd chartlets.py
pip install .[doc]
cd ..

With repository root as current working directory:

# Write
mkdocs serve

# Publish
mkdocs build
mkdocs gh-deploy

License

Chartlets is open source made available under the terms and conditions of the MIT License.