https://github.com/stuartellis/copier-sve-python

Python project template using the Copier tool
https://github.com/stuartellis/copier-sve-python

copier-template

Last synced: 6 months ago
JSON representation

Python project template using the Copier tool

• Host: GitHub
• URL: https://github.com/stuartellis/copier-sve-python
• Owner: stuartellis
• License: mit
• Created: 2024-12-20T11:52:38.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-03-25T22:52:13.000Z (7 months ago)
• Last Synced: 2025-03-25T23:31:11.451Z (7 months ago)
• Topics: copier-template
• Language: Jinja
• Homepage:
• Size: 112 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


# copier-sve-python

[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

This [Copier](https://copier.readthedocs.io/en/stable/) template provides essential files for a Python project.

These files enable a set of additional tools:

- [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)

- [MkDocs](https://www.mkdocs.org)

- [pre-commit](https://pre-commit.com)

- [Trivy](https://trivy.dev)

- [yamllint](https://yamllint.readthedocs.io)

## Install

You need [Copier](https://copier.readthedocs.io/en/stable/) to use this template.

Use [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/) to install Copier. For example, run this command to install Copier with _uv_:

```shell

uv tool install copier

```

## Usage

To create a project with this template, use the _copy_ sub-command:

```shell

copier copy git+https://github.com/stuartellis/copier-sve-python your-project-name

```

To update a project again with this template, run these commands:

```shell

cd your-project-name

copier update -a .copier-answers-python.yaml .

```

## Contributing

The current version of this project is not for general use.

Some configuration files for this project are managed by my [baseline](https://github.com/stuartellis/copier-sve-baseline) Copier template. To synchronize this project with the baseline template, run these commands:

```shell

cd copier-sve-python

copier update -a .copier-answers-baseline.yaml .

```

## License

MIT © 2025 Stuart Ellis