diff --git a/README.md b/README.md index 4ffd648..d1746cd 100644 --- a/README.md +++ b/README.md @@ -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 +``` diff --git a/sample/__init__.py b/cool_domain/__init__.py similarity index 100% rename from sample/__init__.py rename to cool_domain/__init__.py diff --git a/sample/__main__.py b/cool_domain/__main__.py similarity index 100% rename from sample/__main__.py rename to cool_domain/__main__.py diff --git a/sample/logs.py b/cool_domain/logs.py similarity index 100% rename from sample/logs.py rename to cool_domain/logs.py diff --git a/sample/params.py b/cool_domain/params.py similarity index 100% rename from sample/params.py rename to cool_domain/params.py diff --git a/pyproject.toml b/pyproject.toml index 35349ce..d4a9324 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]