Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juftin/cookiecutter-python
juftin's personal cookiecutter template for python projects
https://github.com/juftin/cookiecutter-python
cookiecutter cookiecutter-python cookiecutter-template python
Last synced: about 1 month ago
JSON representation
juftin's personal cookiecutter template for python projects
- Host: GitHub
- URL: https://github.com/juftin/cookiecutter-python
- Owner: juftin
- License: mit
- Created: 2022-08-11T03:30:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T13:42:09.000Z (9 months ago)
- Last Synced: 2024-05-01T16:21:03.459Z (8 months ago)
- Topics: cookiecutter, cookiecutter-python, cookiecutter-template, python
- Language: Python
- Homepage: https://juftin.com/cookiecutter-python
- Size: 221 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
cookiecutter-python
[juftin]'s personal [cookiecutter] template for Python projects.
```shell
cookiecutter gh:juftin/cookiecutter-python
```
## Features
- [hatch] for managing the project's virtual environment and development tools
- [ruff] for code formatting and linting
- [mypy] for type checking
- [hatch-pip-compile] for dependency management + lockfiles
- [pre-commit] for managing git hooks
- [GitHub Actions] for CI/CD
- [MkDocs] and [mkdocs-material] for documentation
- [GitHub Pages] for hosting documentation
- [semantic-release] and [gitmoji] for automated releases
- Publishes to [PyPI] and [Docker Hub]
## Quickstart Guide
### Requirements
Install [cookiecutter]:
```shell
pipx install cookiecutter
```
[pipx] is preferred, but you can also install with `pip install --user`.
### Creating a project
#### Cookiecutter
Generate a Python project:
```shell
cookiecutter gh:juftin/cookiecutter-python
```
#### Git Init
Change to the root directory of your new project, create a Git
repository, and install [pre-commit]
```shell
git init
pre-commit install
git add .
pre-commit run --all-files
git add .
git commit
```
Also, make sure to commit your lockfiles, they're created at `requirements.txt`
and in the `requirements` directory. They will be created automatically
when you run a `hatch` command in the respective environment for the first time.
```shell
hatch run cov
hatch run lint:all
hatch run docs:serve
git add requirements.txt requirements/
git commit -m "🔐 add lockfiles"
```
#### Secrets Init
This project uses GitHub Actions to deploy releases, documentation, and
to publish artifacts to PyPI / Docker Hub. You will need to create
secrets in your GitHub repository to enable these features.
- `PERSONAL_ACCESS_TOKEN`: A GitHub Personal Access Token with `repo` permissions
- `PYPI_TOKEN`: Your PyPI token (optional)
- `DOCKER_USERNAME`: Your Docker Hub username (optional)
- `DOCKER_TOKEN`: Your Docker Hub token (optional)
A `.env` file is provided in the project root for local development, to
sync your secrets to GitHub, run the following command with the [GitHub CLI]:
```shell
gh secret set --env-file .env
```
#### cruft
[cruft] is a tool for updating cookiecutter templates after they've been
generated. To use cruft, install it with `pipx`:
```shell
pipx install cruft
```
Then, use `cruft` instead of `cookiecutter` to generate your project:
```shell
cruft create https://github.com/juftin/cookiecutter-python
```
Later, if you want to update your project with the latest changes from
the template:
```shell
cruft update
```
#### Developing
This project generates its own documentation for how to use the
project's tools. To view the documentation locally, run:
```shell
hatch run docs:serve
```
Once the server is running, you can view the documentation at
[localhost:8080/contributing] or see a preview at [juftin.com/cookiecutter-python/contributing].
[pre-commit]: https://github.com/pre-commit/pre-commit
[gitmoji]: https://gitmoji.dev
[semantic-release]: https://github.com/semantic-release/semantic-release
[Cookiecutter]: https://github.com/cookiecutter/cookiecutter
[hatch]: https://github.com/pypa/hatch
[MkDocs]: https://github.com/mkdocs/mkdocs
[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
[Github Actions]: https://github.com/features/actions
[Github Pages]: https://pages.github.com/
[juftin]: https://github.com/juftin
[pipx]: https://github.com/pypa/pipx
[PyPI]: https://pypi.org/
[Docker Hub]: https://hub.docker.com/
[hatch-pip-compile]: https://github.com/juftin/hatch-pip-compile
[GitHub CLI]: https://cli.github.com/
[localhost:8080/contributing]: http://localhost:8080/contributing
[ruff]: https://github.com/astral/ruff/
[mypy]: https://github.com/python/mypy
[juftin.com/cookiecutter-python/contributing]: https://juftin.com/cookiecutter-python/contributing/
[cruft]: https://github.com/cruft/cruft