fuzzy-couscous
✨📚✨ Read the full documentation
A cli tool based on django's startproject --template to bootstrap your django projects with a modern stack. The project template is heavily inspired by cookiecutter-django but is meant to be a simpler version. The cli also comes with additional commands to hopefully improve your django development experience.
Features
- Django 4+
- Python 3.10+
- Frontend: htmx with editor support using web-types
- Template fragment with django-template-partials
- Secure production settings, https only.
- Settings using django-environ
- Login / signup via django-allauth
- Login using email instead of username
- Automatically reload your browser in development via django-browser-reload
- Better development experience with django-fastdev
- Amazon SES for production email via Anymail
- Docker ready for production
- Optional production cache settings using the
CACHE_URLorREDIS_URLenvironment variables. captain-definitionfor deploying to caprover- Sentry for performance/error monitoring
- Serve static files with Whitenoise
- Default integration with pre-commit for identifying simple issues before submission to code review
- Integrated task runner with poethepoet
- Dependency management using poetry (can be replaced by virtualenv using the
remove-poetrycommand)
Templates
I use github branches to create variations of the base template.
- main: The base template
- tailwind: The base template + tailwindcss via pytailwindcss
- bootstrap: The base template + bootstrap5 via django-bootstrap5
Note: If some of my decisions about the project template don't make sense to you, read this section of the documentation.
Quickstart
Install the latest version of the package
pip install fuzzy-couscous --upgrade
Initialize a new project
cuzzy make project_name
Development
Poetry is required (not really, you can set up the environment however you want and install the requirements manually) to set up a virtualenv, install it then run the following:
pre-commit install --install-hooks
Tests can then be run quickly in that environment:
pytest
Feedback
If you have any feedback, please reach out to me at tobidegnon@proton.me or open a discussion.
Contributors
1 maintainer
Release files for fuzzy-couscous 3.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fuzzy_couscous-3.1.3.tar.gz | 15.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fuzzy_couscous-3.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.4 kB
Release files / fuzzy_couscous-3.1.3.tar.gz
| Download URL | fuzzy_couscous-3.1.3.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c91768bb79298fa461d88d3d0c243ecd2531a5cd5363d61500e7663565c99ff1
|
|
BLAKE2b-256 checksum How to use checksums |
6143a943e1dc1ef69f8153f2efea6e2d45c8e50cf7ff002fb67d16d5c501ac0a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.12.1 Linux/6.6.7-200.fc39.x86_64
|
Release files / fuzzy_couscous-3.1.3-py3-none-any.whl
| Download URL | fuzzy_couscous-3.1.3-py3-none-any.whl |
|---|---|
| Size | 18.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b28cfa771dd0015c15c8bf35c5d3013f5ab4c61087b436be4b1a88ec4639aad0
|
|
BLAKE2b-256 checksum How to use checksums |
b0ac2dd7722d3d1a3675e2648b3643438f11f44ea06f4f5ca805fcb6903d5bde
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.12.1 Linux/6.6.7-200.fc39.x86_64
|
