A cli tool to bootstrap your django projects and enhance your development experience.
Project description
fuzzy-couscous
[!WARNING] Please note that this project, will no longer receive further updates. Instead, check out its new and cooler brother, falco at: https://github.com/tobi-de/falco.
✨📚✨ 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
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-3.1.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b28cfa771dd0015c15c8bf35c5d3013f5ab4c61087b436be4b1a88ec4639aad0 |
|
| MD5 | ec9e848793b2c17400f678813717549c |
|
| BLAKE2b-256 | b0ac2dd7722d3d1a3675e2648b3643438f11f44ea06f4f5ca805fcb6903d5bde |
