Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.
/ fuzzy-couscous Public archive

A cli tool to bootstrap your django projects and enhance your development experience.

License

Notifications You must be signed in to change notification settings

Tobi-De/fuzzy-couscous

Repository files navigation

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.

CD CI pypi Docs: Mkdocs Ruff MIT License

✨📚✨ 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.

showcase gif

Features

Templates

I use github branches to create variations of the base template.

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