A cli tool to bootstrap your django projects and enhance your development experience.
Project description
fuzzy-couscous
✨📚✨ Read the full documentation
My highly opinionated django project template based on django's startproject --template. This project is heavily inspired by cookiecutter-django but is meant to be a lighter version. This template also comes with a cli tool 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-render-block
- Secure production settings, https only.
- Settings using django-environ
- Login / signup via django-allauth
- Custom user model based on django-improved-user
- 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_URL
orREDIS_URL
environment variables. captain-definition
for 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-poetry
command)
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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fuzzy_couscous-2.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c420ea32a35f92f86e0f17f585802a0f959b24eb5cb6c40b5fb03b22a9f4e17 |
|
MD5 | 1518414c5521248e5ff8f268b7c8511a |
|
BLAKE2b-256 | 19e85c7b60a86266f85619c32192e3d58d2bcb2c22091f9f9d60a3cfb16bf0df |