https://github.com/extrange/project-template
Template repository for all my projects.
https://github.com/extrange/project-template
Last synced: 4 months ago
JSON representation
Template repository for all my projects.
- Host: GitHub
- URL: https://github.com/extrange/project-template
- Owner: extrange
- Created: 2024-08-10T12:39:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-29T12:17:01.000Z (6 months ago)
- Last Synced: 2025-01-19T20:01:38.873Z (5 months ago)
- Language: Dockerfile
- Size: 291 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Template
My personal project template, for my Python/TS projects.
Features:
- Automated testing (via Dockerfile `test` stage) with coverage report via GHA
- Linting with Ruff
- Secret scanning
- Dockerfile with non-root user
- [`src/` project layout][src-layout]
## Getting Started
You will need to have `uv` installed.
To start using this template, click 'Use this template' on the top right.
Create a root `env/` folder, and add `local.env` and `prod.env` inside for your local and production environment variables respectively.
Run `uv sync`.
Run your project with `python -m my_project.main`.
If you found this template useful, feel free to contribute back!
## Useful Info
Skip pre-commit hooks:
`git commit --no-verify -m 'my commit'`
[src-layout]: https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html#src-layout