Wizard Template’s Documentation#
Let the wizard do the heavy lifting so you can focus on your craft
Project Management 🧙🏻♂️
This is a general-purpose template that aims to provide a magical start to any Python project.
Quality Assurance ✅
Use pre-commit hooks, linters, formatters, and unit tests to ensure your code is up to standard.
Documentation 📚
Write documentation with Jupyter Book, including API references, interactive tutorials, and more.
Versioning/Changelog 📜
Commitless versioning and changelog management with git tags, pull request labels and GitHub releases.
Automated CI/CD 🚀
Test, build, and publish your package to PyPi. Publish documentation to GitHub Pages.
Further Reading 📖
Resources and references to help you get the most out of this template.
This documentation is organized into a few major sections:
Getting Started provides an overview of the project and how to set it up.
User Guide contains details on how to use the template and the tools it provides.
Reference section includes further reading, besides API references and How to Contribute guides that are ready to be used by any project built with this template.