https://github.com/Tobi-De/fuzzy-couscous
A cli tool to bootstrap your django projects and enhance your development experience.
https://github.com/Tobi-De/fuzzy-couscous
cookiecutter django python template
Last synced: 26 days ago
JSON representation
A cli tool to bootstrap your django projects and enhance your development experience.
- Host: GitHub
- URL: https://github.com/Tobi-De/fuzzy-couscous
- Owner: Tobi-De
- License: mit
- Archived: true
- Created: 2022-11-17T08:06:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-27T16:06:57.000Z (over 1 year ago)
- Last Synced: 2025-03-07T15:41:48.741Z (about 2 months ago)
- Topics: cookiecutter, django, python, template
- Language: Python
- Homepage: https://tobi-de.github.io/fuzzy-couscous
- Size: 7.89 MB
- Stars: 62
- Watchers: 0
- Forks: 4
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-django - fuzzy-couscous - A cli tool to bootstrap your django projects and enhance your development experience. (Boilerplate)
- stars - Tobi-De/fuzzy-couscous - A cli tool to bootstrap your django projects and enhance your development experience. (Python)
- stars - Tobi-De/fuzzy-couscous - A cli tool to bootstrap your django projects and enhance your development experience. (Python)
README
# 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](https://github.com/tobi-de/falco).
[](https://github.com/Tobi-De/fuzzy-couscous/actions/workflows/deploy.yml)
[](https://github.com/Tobi-De/fuzzy-couscous/actions/workflows/test.yml)
[](https://pypi.org/project/fuzzy-couscous/)
[](https://tobi-de.github.io/fuzzy-couscous)
[](https://github.com/astral-sh/ruff)
[](https://github.com/Tobi-De/fuzzy-couscous/blob/main/LICENSE)✨📚✨ [Read the full documentation](https://tobi-de.github.io/fuzzy-couscous)
A cli tool based on [django's startproject --template](https://docs.djangoproject.com/en/stable/ref/django-admin/#startproject) to bootstrap
your django projects with a modern stack. The project template is heavily inspired by [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django) but is meant to be a simpler version.
The cli also comes with [additional commands](https://tobi-de.github.io/fuzzy-couscous/usage/#cuzzy) to hopefully improve your django development experience.
## Features
- Django 4+
- Python 3.10+
- Frontend: [htmx](https://htmx.org/) with [editor support](https://oluwatobi.dev/blog/posts/htmx-support-in-pycharm/) using [web-types](https://github.com/JetBrains/web-types#web-types)
- Template fragment with [django-template-partials](https://github.com/carltongibson/django-template-partials)
- Secure production settings, https only.
- Settings using [django-environ](https://github.com/joke2k/django-environ)
- Login / signup via [django-allauth](https://github.com/pennersr/django-allauth)
- Login using email instead of username
- Automatically reload your browser in development via [django-browser-reload](https://github.com/adamchainz/django-browser-reload)
- Better development experience with [django-fastdev](https://github.com/boxed/django-fastdev)
- [Amazon SES](https://aws.amazon.com/ses/?nc1=h_ls) for production email via [Anymail](https://github.com/anymail/django-anymail)
- [Docker](https://www.docker.com/) ready for production
- Optional production cache settings using the `CACHE_URL` or `REDIS_URL` environment variables.
- `captain-definition` for deploying to [caprover](https://caprover.com/)
- [Sentry](https://sentry.io/welcome/) for performance/error monitoring
- Serve static files with [Whitenoise](https://whitenoise.evans.io/en/latest/)
- Default integration with [pre-commit](https://github.com/pre-commit/pre-commit) for identifying simple issues before submission to code review
- Integrated task runner with [poethepoet](https://github.com/nat-n/poethepoet)
- Dependency management using [poetry](https://github.com/python-poetry/poetry) (can be replaced by [virtualenv](https://github.com/pypa/virtualenv) using the [`remove-poetry` command](https://tobi-de.github.io/fuzzy-couscous/usage/#cuzzy-remove-poetry))## Templates
I use github branches to create variations of the base template.
- [main](https://github.com/Tobi-De/fuzzy-couscous): The base template
- [tailwind](https://github.com/Tobi-De/fuzzy-couscous/tree/tailwind): The base template + [tailwindcss](https://github.com/timonweb/pytailwindcss) via [pytailwindcss](https://github.com/timonweb/pytailwindcss)
- [bootstrap](https://github.com/Tobi-De/fuzzy-couscous/tree/bootstrap): The base template + [bootstrap5](https://getbootstrap.com/) via [django-bootstrap5](https://github.com/zostera/django-bootstrap5)> **Note**: If some of my decisions about the project template don't make sense to you, read [this section](https://tobi-de.github.io/fuzzy-couscous/project/) of the documentation.
## Quickstart
Install the latest version of the package
```shell
pip install fuzzy-couscous --upgrade
```Initialize a new project
```shell
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:```sh
pre-commit install --install-hooks
```Tests can then be run quickly in that environment:
```sh
pytest
```## Feedback
If you have any feedback, please reach out to me at tobidegnon@proton.me or [open a discussion](https://github.com/Tobi-De/fuzzy-couscous/discussions/new).
## Contributors
