Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matagus/django-app-starter
A copier template for generating a Django app. Python 3.9-3.12 and Django 4.x-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!
https://github.com/matagus/django-app-starter
boilerplate-application boilerplate-template copier copier-python copier-template django django-app-generator django-app-skeleton python starter-app starter-template template-app
Last synced: 3 months ago
JSON representation
A copier template for generating a Django app. Python 3.9-3.12 and Django 4.x-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!
- Host: GitHub
- URL: https://github.com/matagus/django-app-starter
- Owner: matagus
- License: mit
- Created: 2024-02-18T18:34:54.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-03T20:40:12.000Z (9 months ago)
- Last Synced: 2024-04-03T21:43:14.416Z (9 months ago)
- Topics: boilerplate-application, boilerplate-template, copier, copier-python, copier-template, django, django-app-generator, django-app-skeleton, python, starter-app, starter-template, template-app
- Language: Jinja
- Homepage:
- Size: 2.81 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# django-app-starter
 [](https://opensource.org/licenses/MIT) [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black)
Generate a new Django app with all the goodies you need to start developing, testing and publishing your app to PyPI
and Github.
## Features
- [x] Compatibility with Python 3.9 to 3.12 and Django 4 to 5.0.3.
- [x] Package management and dynamic versioning using [Hatch](https://hatch.pypa.io/latest/install/).
- [x] Testing with `hatch` for all possible combinations of Python and Django versions.
- [x] Code coverage reporting to using [Coverage.py](https://coverage.readthedocs.io/en/latest/).
- [x] Ready to use [GitHub Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions)
pipelines for:
* [x] CI + reporting code coverage to codecov.io
* [x] Building and publishing to Pypi when a new tag is pushed
* [x] Creating a draft release
- [x] `pre-commit` configuration with:
- [x] `black` for code formatting
- [x] Linting and formatting with [`ruff`](https://github.com/charliermarsh/ruff)
- [x] `codespell`, `pyupgrade` and several standard checks.
- [x] Consistent coding styles for multiple editors and IDEs via [.editorconfig](https://editorconfig.org/) file.
- [x] Configuration using `pyproject.toml` file.
- [x] `README.md` file with instructions on how to start developing, testing and publishing your app.
- [x] An `example_project` fully configured to try you app from the start.
- [x] Dependency updates with [Dependabot](https://github.com/dependabot).
- [x] Issues templates for bugs and features, a Code of conduct file referencing Django's CoC, and a Security Policy
config.
- [x] Sync updates from newest versions of this template with [Copier](https://copier.readthedocs.io/en/stable/updating/).
- [x] Standardised list of GitHub labels synchronised on push to main branch using [the labels CLI](https://github.com/hackebrot/labels).
- [x] Documentation with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and docstring reference
support with [mkdocstrings](https://mkdocstrings.github.io/).
- [x] Latest stable documentation published to [GitHub](https://docs.github.com/en/pages)/[GitLab](https://docs.gitlab.com/ee/user/project/pages/) Pages.
## Coming Soon
- [ ] [Versioned documentation](https://docs.readthedocs.io/en/stable/versions.html) and [pull request previews](https://docs.readthedocs.io/en/stable/pull-requests.html) with [Read the Docs](https://readthedocs.org/).
- [ ] Containerization for development and deployment with [dev container](https://containers.dev/).
- [ ] Follow the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
- [ ] Turn Github repository in to a [Template Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository)
that does all the setup so people don't need to install copier and run it locally. Similar to what Simon Willison did
with [his cookicutter template](https://github.com/simonw/python-lib-template-repository)
## Usage
### Prerequisites
You need to have `copier` and `hatch` installed in your system. If you don't have them, you can install them with:
```
pip install copier
pip install hatch
```
Then generating a new Django app is as simple as running:
```
copier copy https://github.com/matagus/django-app-starter
```
You will be prompted to enter some data needed to generate your app, and then you will have a new directory with your
app ready to go.
`django-app-starter` comes wwith an example project you can use to test your app. To run it just do:
```
cd
hatch run project:migrate
hatch run project:createsuperuser
hatch run project:runserver
```
Also, you can run the tests (for all the Python + Django valid combinations) with:
```
hatch run test:test
```
And you can check the coverage with:
```
hatch run test:cov
```
To run tests for a specific Python and Django version, for instance Python 3.12 and Django 5.0, you can use:
```
hatch run test.py3.12-5.0:test
```
Learn more about `hatch` and its commands in the [official documentation](https://hatch.pypa.io/latest/) or
just ask for help in our [Discussion section](https://github.com/matagus/django-app-starter/discussions).
## Contributing
Contributions are welcome! ❤️
## License
`django-app-starter` is released under an MIT License - see the `LICENSE` file for more information.
## Webliography
- [Copier Documentation](https://copier.readthedocs.io/en/stable/)
- [Project templating tools: Cookiecutter, Yeoman, and Copier](https://www.cookiecutter.io/article-post/cookiecutter-alternatives)