-
Notifications
You must be signed in to change notification settings - Fork 3
feat: update README with additional Renovate Dog instructions and new… #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Cookiecutter Django | ||
|
|
||
| ## Features | ||
|
|
||
| - Django 6 | ||
| - Python 3.14, 3.13, 3.12 | ||
| - PostgreSQL 18, 17, 16 | ||
| - Package and Project management with uv | ||
| - Pre-commit hooks for code quality and formatting | ||
| - ruff | ||
| - Optional DRF (Django Rest Framework) setup | ||
| - GitLab CI/CD | ||
| - pre-commit checks | ||
| - django tests | ||
| - deployment checks | ||
| - automated deployment to our staging environment | ||
| - Dependency Tracking | ||
| - Custom `User` model | ||
| - ``common`` directory with utility functions and classes | ||
|
|
||
| ## `cookiecutter.json` questions | ||
|
|
||
| 1. `project_name` - Human-readable project name | ||
| - Used in the README and API documentation. | ||
|
|
||
| 2. `project_slug` - Project identifier / Python package name (slugified) | ||
| - Used throughout the codebase, e.g. in `import` statements, as the Django project/module name, and in the GitLab | ||
| CI/CD configuration. | ||
| - Use a valid Python module name (typically lowercase letters, numbers, and underscores; must not start with a | ||
| number). | ||
|
|
||
| 3. `customer` - Customer/client name (optional) | ||
| - Used in the README. | ||
|
|
||
| 4. `python_version` - Python version for the project | ||
| - Prefer the latest stable Python version that is supported by Django and your dependencies. | ||
|
|
||
| 5. `postgresql_version` - PostgreSQL version for the project | ||
| - Prefer the latest stable PostgreSQL version. | ||
|
|
||
| 6. `username_type` - Identifier used to log in (for the Django user model) | ||
| - Commonly set to `email` for customer projects. (This affects the custom user model and should be chosen early.) | ||
|
|
||
| 7. `use_drf` - Include Django REST Framework (DRF) | ||
| - If set to `yes`, DRF, drf-spectacular, django-filter, and django-cors-headers will be installed and preconfigured. | ||
|
|
||
| ## ``common`` directory | ||
|
|
||
| The ``common`` directory contains basic utility functions for models, Django management commands, tests. If DRF is | ||
| enabled, it also contains filters, a BinaryRenderer and a MultipleSerializersMixin for ViewSets. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.