Skip to content

Commit

Permalink
Merge pull request #5 from fpgmaas/feature/tox-uv
Browse files Browse the repository at this point in the history
Replace tox with tox-uv
  • Loading branch information
fpgmaas authored Sep 16, 2024
2 parents ad39774 + 6b80c62 commit 02cf32e
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 10 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.PHONY: bake
bake: ## bake without inputs and overwrite if exists.
@cookiecutter --no-input . --overwrite-if-exists
@uv run cookiecutter --no-input . --overwrite-if-exists

.PHONY: bake-with-inputs
bake-with-inputs: ## bake with inputs and overwrite if exists.
@cookiecutter . --overwrite-if-exists
@uv run cookiecutter . --overwrite-if-exists

.PHONY: bake-and-test-deploy
bake-and-test-deploy: ## For quick publishing to cookiecutter-uv-example to test GH Actions
@rm -rf cookiecutter-uv-example || true
@cookiecutter --no-input . --overwrite-if-exists \
@uv run cookiecutter --no-input . --overwrite-if-exists \
author="Florian Maas" \
email="[email protected]" \
github_author_handle=fpgmaas \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro
- Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub
- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)
- Documentation with [MkDocs](https://www.mkdocs.org/)
- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)
- Compatibility testing for multiple versions of Python with [tox-uv](https://github.com/tox-dev/tox-uv)
- Containerization with [Docker](https://www.docker.com/)
- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)

Expand Down
2 changes: 1 addition & 1 deletion docs/features/tox.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Compatibility testing with Tox

If `tox` is set to `"y"` project uses [Tox](https://tox.wiki/en/latest/)
If `tox` is set to `"y"` project uses [tox-uv](https://github.com/tox-dev/tox-uv)
to test compatibility with multiple Python versions. You can run `tox` locally:

```sh
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro
- Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub
- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)
- Documentation with [MkDocs](https://www.mkdocs.org/)
- Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)
- Compatibility testing for multiple versions of Python with [tox-uv](https://github.com/tox-dev/tox-uv)
- Containerization with [Docker](https://www.docker.com/)
- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ dev-dependencies = [
"pytest>=7.2.0",
"pre-commit>=2.20.0",
"pytest-cookies>=0.6.1",
"tox>=3.25.1",
"tox-uv>=1.11.3",
"deptry>=0.20.0",
"mypy>=0.991",
"pytest-cov>=4.0.0",
Expand Down
57 changes: 55 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Documentation = "https://{{cookiecutter.author_github_handle}}.github.io/{{cooki
dev-dependencies = [
"pytest>=7.2.0",
"pre-commit>=2.20.0",
"tox>=3.25.1",
"tox-uv>=1.11.3",
{% if cookiecutter.deptry == 'y' %}"deptry>=0.20.0",{% endif %}
"mypy>=0.991",
{% if cookiecutter.codecov == 'y' %}"pytest-cov>=4.0.0",{% endif %}
Expand Down

0 comments on commit 02cf32e

Please sign in to comment.