https://github.com/titom73/cookiecutter-python-project
A cookiecutter project for Python 3 (readonly version)
https://github.com/titom73/cookiecutter-python-project
cookiecutter cookiecutter-python3 cookiecutter-template
Last synced: 4 months ago
JSON representation
A cookiecutter project for Python 3 (readonly version)
- Host: GitHub
- URL: https://github.com/titom73/cookiecutter-python-project
- Owner: titom73
- License: apache-2.0
- Created: 2024-05-28T08:25:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-04T13:50:21.000Z (over 1 year ago)
- Last Synced: 2025-03-04T20:46:20.133Z (11 months ago)
- Topics: cookiecutter, cookiecutter-python3, cookiecutter-template
- Language: Python
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Python Project template
## Overview
Git repository to easily generate structure for a Python 3 project with the following elements:
- `pyproject.toml` for python packaging
- `Ruff`, `Pylint`, `Mypy` configurations
- `tox` configurations
- `pre-commit` hook configuration (__not installed__: run `pre-commit install`)
- `Dockerfile` for easy packaging
- GH actions for standard CI.
- [Drone CI](https://www.drone.io/) for homelab CI.
- Devcontainer and VScode settings
- Licence selection
## Getting Started
```bash
# Install cookiecutter (if not already installed)
pipx install cookiecutter jinja2-time
# Create your project (custom git server)
cookiecutter git@git.as73.inetsix.net:Templates/cookiecutter-python-project.git
# Create your project (github)
cookiecutter gh:titom73/cookiecutter-python-project.git
```
## Project inputs
This project uses following inputs to build content:
- `author`: Author Full Name
- `email`: Author Email address,
- `author_github_handle`: Git Nickname,
- `git_server`: Git server,
- `project_name`: Project's name (similar to repository name), it will be used to derive a slug,
- `package_name`: default is `{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}`,
- `project_description`: Project description,
- `version`: Initial version of the project,
- `include_github_actions`: Activate or not GH Actions,
- `include_drone_ci`: Activate or not [Drone-CI](https://www.drone.io/)
- `codecov`: Activate or not Codecov,
- `dockerfile`: Activate or not Dockerfile,
- `devcontainer`: Activate or not Devcontainer,
- `open_source_license`: Project's licence type,
### Hidden variables
Some variables are automatically built by cookicutter:
- `__year`: `{% now 'utc', '%Y' %}`,
## Contribution guide
Contributions are welcome. Please refer to the [contribution guide](./CONTRIBUTING.md)
## Licence
The project is published under [Apache-2.0](./LICENCE)