Django App Starter
A copier template for generating a Django app. Python 3.10-3.13 and Django 5.x compatible, pre-commit, test matrix + coverage, Github actions for CI, publish to Pypi & create release, github issues config + templates, docs with MkDocs + Material, and more!
Overview
The django-app-starter template is an ideal solution for developers looking to kickstart their Django projects efficiently. This tool streamlines the process of creating, testing, and deploying Django applications, making it easy to manage everything from dependencies to documentation. With built-in support for multiple Python versions and automatic configuration, this template is a game-changer for both novice and experienced developers.
What sets django-app-starter apart is its comprehensive feature set that emphasizes best practices in coding, testing, and deployment. Whether you're looking to publish your app to PyPI or set up CI/CD pipelines with GitHub Actions, this template has you covered with minimal setup time.
Features
- Python and Django Compatibility: Works seamlessly with Python versions 3.10 to 3.13 and Django 5.x for flexibility in your projects.
- Dynamic Versioning with Hatch: Manages packaging and dependencies dynamically, making version control straightforward and efficient.
- Comprehensive Testing Suite: Offers testing configurations for various combinations of Python and Django versions, ensuring reliability in your code.
- Code Coverage Reporting: Utilizes Coverage.py for thorough code coverage checks, helping you maintain high-quality code standards.
- Pre-configured GitHub Actions: Includes ready-to-use CI pipelines for code coverage reporting, building, and publishing to PyPI, simplifying your deployment process.
- Pre-commit Configurations: Integrates multiple tools like black for formatting and ruff for linting, ensuring a consistent coding style across different environments.
- Documentation Generation: Automatically generates documentation using Material for MkDocs, enhancing the accessibility and usability of your project’s information.
- Example Project Included: Comes with a fully configured example project to help you test and understand your app setup from the get-go.
This template not only simplifies the initiation of Django projects but also maintains a focus on quality and manageability, making it an excellent choice for all developers.
- Django
Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. It follows the model-view-controller (MVC) architectural pattern, providing an extensive set of built-in tools and conventions to streamline the creation of robust and scalable web applications.