From 69a797c82c0e7e80da96a7986b2e06a98de01f18 Mon Sep 17 00:00:00 2001 From: Florian Maas Date: Thu, 14 Dec 2023 14:58:19 +0100 Subject: [PATCH] docs --- README.md | 7 ++----- docs/index.md | 7 ++----- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 45aa642..94d176d 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,13 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro - [Poetry](https://python-poetry.org/) for dependency management - CI/CD with [GitHub Actions](https://github.com/features/actions) - Pre-commit hooks with [pre-commit](https://pre-commit.com/) -- Code quality with: - - [ruff](https://github.com/charliermarsh/ruff) - - [mypy](https://mypy.readthedocs.io/en/stable/) - - [deptry](https://github.com/fpgmaas/deptry/) - - [prettier](https://prettier.io/) +- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/fpgmaas/deptry/) and [prettier](https://prettier.io/) - Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) 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/) - Containerization with [Docker](https://www.docker.com/) +- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers) --- diff --git a/docs/index.md b/docs/index.md index 4e8b605..c509825 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,16 +20,13 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro - [Poetry](https://python-poetry.org/) for dependency management - CI/CD with [GitHub Actions](https://github.com/features/actions) - Pre-commit hooks with [pre-commit](https://pre-commit.com/) -- Code quality with: - - [ruff](https://github.com/charliermarsh/ruff) - - [mypy](https://mypy.readthedocs.io/en/stable/) - - [deptry](https://github.com/fpgmaas/deptry/) - - [prettier](https://prettier.io/) +- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/fpgmaas/deptry/) and [prettier](https://prettier.io/) - Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) 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/) - Containerization with [Docker](https://www.docker.com/) +- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers) An example of a repository generated with this package can be found [here](https://github.com/fpgmaas/cookiecutter-poetry-example).