klemek/cool-domain
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

chore: template usage
Python Lint CI / ruff (push) Successful in 48s
Details
Python Lint CI / ruff-format-check (push) Successful in 48s
Details
Python Lint CI / ty (push) Successful in 48s
Details
Python Test CI / coverage (push) Successful in 1m44s
Details

Browse Source
This commit is contained in:
klemek
2026-06-15 10:27:21 +02:00
parent 093c553f6c
commit 11de7386f0
6 changed files with 15 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -7
View File
@@ -1,11 +1,14 @@
[![](https://git.klemek.fr/klemek/python-template/actions/workflows/lint.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/python-template/actions?workflow=lint.yml) [![](https://git.klemek.fr/klemek/python-template/actions/workflows/test.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/python-template/actions?workflow=test.yml)
[![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/lint.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=lint.yml) [![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/test.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=test.yml)
##
# Python Template
```bash
# install with pip
pip install git+https://git.klemek.fr/klemek/cool-domain
## Use this template
# run with pipx
pipx run --spec git+https://git.klemek.fr/klemek/cool-domain cool-domain
- [ ] 1. rename foler `sample` to match project
- [ ] 2. rename project in `pyproject.toml`
- [ ] 3. update `README.md`
- [ ] 4. enjoy
# run with uvx
uvx --from git+https://git.klemek.fr/klemek/cool-domain cool-domain
```
sample/__init__.py → cool_domain/__init__.py
View File
sample/__main__.py → cool_domain/__main__.py
View File
sample/logs.py → cool_domain/logs.py
View File
sample/params.py → cool_domain/params.py
View File
pyproject.toml
+5 -5
View File
@@ -1,5 +1,5 @@
[project]
name = "sample" # TODO: 2. rename project
name = "cool-domain"
version = "0.0.0"
description = "Add your description here"
readme = "README.md"
@@ -7,7 +7,7 @@ requires-python = ">=3.14"
dependencies = []
[project.scripts]
sample = "sample.__main__:main" # TODO: 2. rename project
cool-domain = "cool_domain.__main__:main"
[build-system]
requires = ["uv_build>=0.11.7,<0.12"]
@@ -15,7 +15,7 @@ build-backend = "uv_build"
[tool.uv.build-backend]
module-root = ""
module-name = "sample" # TODO: 2. rename project
module-name = "cool_domain"
[dependency-groups]
dev = [
@@ -30,5 +30,5 @@ select = ["ALL"]
ignore = ["D", "E501", "ANN401", "BLE001", "COM812", "S101", "PT"]
[tool.coverage.run]
source = ["sample"] # TODO: 2. rename project
omit = ["sample/logs.py", "sample/__main__.py"]
source = ["cool_domain"]
omit = ["cool_domain/logs.py", "cool_domain/__main__.py"]