https://github.com/sidisinsane/copier-python-hatch-template

A Copier template for Python projects managed by Hatch.
https://github.com/sidisinsane/copier-python-hatch-template

copier-template hatch project-template python scaffolding

Last synced: 10 days ago
JSON representation

A Copier template for Python projects managed by Hatch.

• Host: GitHub
• URL: https://github.com/sidisinsane/copier-python-hatch-template
• Owner: sidisinsane
• License: mit
• Created: 2024-03-25T08:09:30.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-27T10:13:57.000Z (about 2 years ago)
• Last Synced: 2024-03-27T20:01:45.555Z (about 2 years ago)
• Topics: copier-template, hatch, project-template, python, scaffolding
• Language: Jinja
• Homepage: https://sidisinsane.github.io/copier-python-hatch-template/
• Size: 684 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




    



# Copier Python Hatch Template

*A Copier template for Python projects managed by Hatch.*

[![License](https://img.shields.io/github/license/sidisinsane/copier-python-hatch-template)](https://github.com/sidisinsane/copier-python-hatch-template/blob/main/LICENSE)

[![CI Status](https://img.shields.io/github/actions/workflow/status/sidisinsane/copier-python-hatch-template/ci.yml?logo=github&label=ci)](https://github.com/sidisinsane/copier-python-hatch-template/blob/main/.github/workflows/ci.yml)

[![CodeQL Status](https://img.shields.io/github/actions/workflow/status/sidisinsane/copier-python-hatch-template/codeql.yml?logo=github&label=codeql)](https://github.com/sidisinsane/copier-python-hatch-template/blob/main/.github/workflows/codeql.yml)

[![GH-Pages Deploy Status](https://img.shields.io/github/actions/workflow/status/sidisinsane/copier-python-hatch-template/gh-pages-deploy.yml?logo=github&label=gh-pages-deploy)](https://github.com/sidisinsane/copier-python-hatch-template/blob/main/.github/workflows/gh-pages-deploy.yml)

[![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/sidisinsane/copier-python-hatch-template/main/pyproject.toml&logo=python&logoColor=white&label=Python)](https://www.python.org/)

[![Copier](https://img.shields.io/badge/Copier-4b5563)](https://copier.readthedocs.io/en/stable/)

[![Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

[![Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

[![Pytest](https://img.shields.io/badge/Pytest-0a9edc?logo=pytest&logoColor=white&labelColor=4b5563)](https://pytest.org/)

[![Markdownlint](https://img.shields.io/badge/Markdownlint-000000?logo=markdown&logoColor=white&labelColor=4b5563)](https://github.com/DavidAnson/markdownlint)

[![Commitlint](https://img.shields.io/badge/Commitlint-3451b2?logo=commitlint&logoColor=white&labelColor=4b5563)](https://commitlint.js.org/)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://docs.astral.sh/ruff/)

[![Bandit](https://img.shields.io/badge/Bandit-4b5563)](https://github.com/PyCQA/bandit)

[![Mypy](https://img.shields.io/badge/Mypy-4b5563)](https://mypy-lang.org/)



## Prerequisites

### Copier

[Copier](https://copier.readthedocs.io/en/stable/) is a library and CLI app for rendering project templates.

#### Install Copier

> [!IMPORTANT]

> If you haven't already, install `pipx` first: `pip install --user pipx`.

```shell

pipx install copier

```

#### Inject Copier Templates Extensions

```shell

pipx inject copier copier-templates-extensions

```

### Hatch

[Hatch](https://hatch.pypa.io/latest/) is a modern, [PEP 621](https://peps.python.org/pep-0621/) compliant, extensible Python project manager.

#### Install Hatch

```shell

pipx install hatch

```

#### Configure Hatch

Store virtual environments in a directory named `.hatch` in each project directory.

```shell

hatch config set dirs.env.virtual .hatch

```

> [!NOTE]

> This adds the following to the configuration:

>

> ```toml

> [dirs.env]

> virtual = ".hatch"

> ```

>

> The [Configuration for Hatch](https://hatch.pypa.io/latest/config/hatch/) is stored in a `config.toml` file at i.e. `~/Library/Application Support/hatch` on macOS.

## Usage

### Generate a Project

```shell

copier copy --trust https://github.com/sidisinsane/copier-python-hatch-template.git PATH/TO/DESTINATION

```

or

```shell

copier copy --trust gh:sidisinsane/copier-python-hatch-template PATH/TO/DESTINATION

```

This will generate a new project with the following structure:

```ascii

YOUR-PROJECT-NAME

├── .github

│   └── workflows

│       ├── ci.yml

│       ├── codeql.yml

│       ├── gh-pages-deploy.yml

│       └── test.yml

├── .vscode

│   ├── extensions.json

│   └── settings.json

├── mkdocs

│   ├── images

│   │   ├── favicon.svg

│   │   └── logo.svg

│   ├── javascripts

│   │   └── mathjax.js

│   ├── index.md

│   └── license.md

├── src

│   └── YOUR_PROJECT_NAME

│       ├── __about__.py

│       ├── __init__.py

│       └── calc.py

├── tests

│   ├── __init__.py

│   └── test_calc.py

├── .coveragerc

├── .gitignore

├── .markdownlint.yml

├── .pre-commit-config.yaml

├── .pylintrc

├── bandit.yml

├── commitlint.config.js

├── LICENSE

├── mkdocs.yml

├── mypy.ini

├── pyproject.toml

├── pytest.ini

└── README.md

```

> [!NOTE]

> You can also clone the project template using `git clone https://github.com/sidisinsane/copier-python-hatch-template.git`, modify it and generate a project the locally cloned repo.

>

> ```shell

> copier copy --trust PATH/TO/CLONED/PROJECT/TEMPLATE PATH/TO/DESTINATION

> ```

## Aftermath

### Create Virtual Environment

```shell

cd PATH/TO/DESTINATION && hatch env create

```

> [!NOTE]  

> You can locate environments by running `hatch env find`.

### Install Pre-Commit Hooks

```shell

git init && hatch run dev:pre-commit-install

```

> [!NOTE]  

> After you have created a new empty GitHub project, you are ready to make your initial commit.

>

> ```shell

> git add .

> git commit -m "initial commit"

> git branch -M main

> git remote add origin 

> git push -u origin main

> ```

See the [documentation](https://sidisinsane.github.io/copier-python-hatch-template/) for more details.