Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: update list of used tools #114

Merged
merged 1 commit into from
Nov 22, 2023
Merged

readme: update list of used tools #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,17 @@ Features
.. features-begin

- Test automation with Nox_
- Linting with pre-commit_, Flake8_ and pylint
- Linting with pre-commit_ and ruff_
- Continuous integration with `GitHub Actions`_
- Documentation with Sphinx_ and `Read the Docs`_ using the furo_ theme
- Automated uploads to PyPI_
- Automated dependency updates with Dependabot_
- Code formatting with Black_
- Import sorting with isort_
- Testing with pytest_
- Code coverage with Coverage.py_
- Coverage reporting with Codecov_
- Static type-checking with mypy_
- Automated Python syntax upgrades with pyupgrade_
- Security audit with Bandit_ and Safety_
- Security audit with Safety_
- setuptools as backend, build as frontend

The template supports Python 3.8, 3.9, 3.10 and 3.11.
Expand All @@ -41,15 +39,11 @@ The template supports Python 3.8, 3.9, 3.10 and 3.11.

.. references-begin

.. _Bandit: https://github.com/PyCQA/bandit
.. _Black: https://github.com/psf/black
.. _Codecov: https://codecov.io/
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _Coverage.py: https://coverage.readthedocs.io/
.. _Dependabot: https://dependabot.com/
.. _Flake8: http://flake8.pycqa.org
.. _GitHub Actions: https://github.com/features/actions
.. _isort: https://pycqa.github.io/isort/
.. _Nox: https://nox.thea.codes/
.. _PyPI: https://pypi.org/
.. _Read the Docs: https://readthedocs.org/
Expand All @@ -58,5 +52,6 @@ The template supports Python 3.8, 3.9, 3.10 and 3.11.
.. _pre-commit: https://pre-commit.com/
.. _pytest: https://docs.pytest.org/en/latest/
.. _pyupgrade: https://github.com/asottile/pyupgrade
.. _ruff: https://github.com/astral-sh/ruff

.. references-end