Python far Cookiecutter

This Cookiecutter template creates Python projects from the project templates.

Features

• Supports Python 3.7 and higher.
• Testing with pytest
• Formatting and Linting with ruff

Prerequisites

• Create projects swiftly from cookiecutters cookiecutter

Install and run far-cookiecutter

Option 1: Using uv

After installing uv, navigate to the directory on your local machine in which you want to create a project directory, and then run the following command:

uvx cookiecutter https://github.com/fouladi/far-cookiecutter

Option 2: Using pipx

Here you have to install first of all the cookiecutter. The following steps are necessary:

# Install pipx if pipenv and cookiecutter are not installed
python -m pip install pipx
python -m pipx ensurepath

# Install cookiecutter using pipx
pipx install cookiecutter

# Use cookiecutter to create project from this template
cookiecutter gh:fouladi/far-cookiecutter

# Or

pipx run cookiecutter far-cookiecutter

How to use it

Follow the on-screen prompts to configure your project. Once you have finished, a new directory containing your project will be created.

• Enter project directory

cd <repo_name>

• Initialise git repo

git init

• Creating Virtual Environments with pyenv

pyenv virtualenv <python-version> <repo_name>

• Install requirements

pip install  -r requirements-dev.txt

• Optional: activate git-hook scripts

pre-commit install