Usage

This page describe how to use the all available commands.

Intro

Note

fuzzy-couscous is the name of the cli installed when you install this package but since it's a bit annoying to type it every time, there is the short version cuzzy that you can use instead. The short version is the one that is used throughout the documentation for the examples.

Since this template uses django's startproject --template, you can easily clone the project on your computer and generate a django project by using the command django-admin and specifying the fuzzy-couscous/templates/project_name folder as the template. The final command is a bit long, that's why I made this cli to simplify the process. The cli command is installed together with the package.

Install the package

pip install fuzzy-couscous --upgrade

cuzzy

Usage:

$ cuzzy [OPTIONS] COMMAND [ARGS]...

Options:

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show the help message and exit.

Commands:

• make: Initialize a new django project.
• remove-poetry: Run this command to remove poetry as a dependency from your project.
• work: Run multiple commands in parallel.
• write-env: Update or create a .env file from a .env.template file.

cuzzy make

Initialize a new django project. This template makes a lot of assumptions, if you want to make some adjustments to the template you can fork the github repository of this project and make your changes in the templates folder, you can then use the --repo option to specify your Github repository.

Custom repository

Actually you don't need to fork my repository, you can use this command on any github repository hosting a django project template as long as the template is defined in a templates folder in the root of the repository. Basically, the github repository structure would look something like this:

```shell
.
├── templates
│   └── project_name
```

Usage:

$ cuzzy make [OPTIONS] PROJECT_NAME

Info

The authors key of the [tool.poetry] section in the pyproject.toml is set using your git global user configuration. If you haven't set it yet, see this page.

Arguments:

• PROJECT_NAME: [required]

Options:

• -r, --repo TEXT: The github repository to pull the template from. The format to use is username/repo [default: Tobi-De/fuzzy-couscous]
• -b, --branch [main|tailwind|bootstrap]: The github branch to use. [default: main]
• -s, --skip-install: Skip dependencies installation. [default: False]
• --help: Show the help message and exit.

cuzzy remove-poetry

Run this command to remove poetry as a dependency from your project, it updates your pyproject.toml file to use hatch as the build system and can optionally create a virtual environment using virtualenv. Hatch is a modern and extensible Python project manager, it can handle environment creation, package publishing, versioning, etc, everything you need to manage a python project, but here I chose to use it only as a build backend. If you add the --create-virtualenv option, pip-tools will be installed in the created environment, you can use it to manage your dependencies. If you are familiar with hatch, you can easily complete the hatch configurations from the generated pyproject.toml file and use it instead of virtualenv to manage your project.

Info

The virtualenv is created using your global python interpreter.

Warning

Be sure to commit your changes before running this command, that way you can undo the changes if something goes wrong or if you simply change your mind

Usage:

$ cuzzy remove-poetry [OPTIONS]

Options:

• -c, --create-virtualenv: Create an environment using virtualenv. [default: False]
• --help: Show the help message and exit.

cuzzy work

This command allows you to run multiple commands simultaneously. Typically, when working with tailwind, you need to run both the django runserver command and the tailwind compile command. This command uses the python package honcho to manage multiple processes. By default, it runs the django server, a redis server (if REDIS_URL is in your environment or .env file), the tailwind compile and watch command if pytailwindcss is listed as a dependency in your pyproject.toml file. It also runs the qcluster command from django-q2 (if defined in your dependencies). Additionally, if hupper is listed as a development dependency, it uses that to run the qcluster command.. You can specify the commands to run in the [tool.cuzzy] section using the work key. If you define a command with the same name as the default, it will override it. Here are the default commands:

[tool.cuzzy]
work = { server = "python manage.py migrate && python manage.py runserver --nostatic", tailwind = "tailwindcss -i project_name/static/css/input.css -o project_name/static/css/output.css --watch", redis = "redis-server" }

Usage:

$ cuzzy work [OPTIONS]

Options:

• --dry-run: Display the list of commands without running them. [default: False]
• --help: Show the help message and exit.

Can be configured via the pyproject.toml file.

[tool.cuzzy]
work = { server = "python manage.py runserver --nostatic", "tailwind" = "poe t", "worker" = "python manage.py qcluster" }

cuzzy write-env

Running this will create a new .env by filling the file with the keys and values from the following options:

1. a env.template file, used if it exists
2. a DEFAULT_VALUES dictionary, internal to the fuzzy-couscous package, contains some default for common keys, DJANGO_DEBUG, DJANGO_SECRET_KEY, etc.
3. a .env file, used if it exists

The order defines the priority of the values that are used, which means that the values contained in your original .env file are preserved if the file exists.

Usage:

$ cuzzy write-env [OPTIONS]

Options:

• -f, --fill-missing: Prompt to fill missing values. [default: False]
• -o, --output-file FILE: The output file path. [default: .env]
• -p, --postgres-pass: Prompt for the postgres password to use to build the DATABASE_URL.
• --help: Show the help message and exit.

cuzzy rm-migrations

Note

This command was previously part of the generated project as a django management command, but I decided to move it to the fuzzy-couscous package since I'm probably the only one using it and I don't want to pollute the generated project with unnecessary code.

Remove all migrations for the specified applications directory, intended only for development.

Warning

This command will delete all your migrations files, be sure to commit your changes before running this command.

Usage:

$ cuzzy rm-migrations [OPTIONS] APPS_DIR

Arguments:

• APPS_DIR: The path to your django apps directory. [required]

Options:

• -e, --exclude TEXT: A file to exclude from the deletion. This option can be repeated.

cuzzy htmx

Download the htmx javascript library or one of its extension if specified. You won't have to download htmx or its extensions often but at least if you need it, I think this is an easy way to get the file available locally.

Usage:

$ cuzzy htmx [OPTIONS] VERSION

Arguments:

• VERSION: The version of htmx to download. [default: latest]

Options:

• -e, --extension TEXT: The name of the extension to download.
• -f, --output-file TEXT: The filename for the htmx download. [default: htmx.min.js]
• -d, --output-dir DIRECTORY: The directory to write the downloaded file to, default to the current working directory.
• -w, --web-types: Download the web-types file.
• --help: Show the help message and exit.