Skip to content

Commit 58d3a96

Browse files
committed
Update template details in README.rst
1 parent c98a223 commit 58d3a96

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Cookiecutter Python Project
22
###########################
33

44
This project contains a Cookiecutter template that helps you create new Python
5-
3.7+ package projects by automatically generating most of the boiler plate
5+
3.11+ package projects by automatically generating most of the boiler plate
66
content for you.
77

88
Cookiecutter is a command-line utility that creates projects from templates.
@@ -21,14 +21,15 @@ the following items:
2121
- A Makefile that automates many common developer tasks, such as:
2222

2323
- Creating a Virtual environment
24-
- Checking code style.
25-
- Performing static analysis checks.
26-
- Running unit tests.
27-
- Checking code coverage.
28-
- Generating documentation.
24+
- Checking and formatting code style with ``black`` and ``isort``.
25+
- Performing static analysis checks with ``pylint``.
26+
- Performing type checking with ``mypy``.
27+
- Running unit tests with Python's ``unittest``.
28+
- Checking code coverage with ``coverage``.
29+
- Generating documentation with ``Sphinx``.
2930
- Generating, testing and uploading a project release to PyPI.
3031

31-
- A ``setup.py`` file used to generate project install and releases.
32+
- A ``pyproject.toml`` file used to manage nearly all project configuration.
3233
- A ``CONTRIBUTING.rst`` guide. On Github this file is shown when sending
3334
a pull request or an issue. This file also gets included in the generated
3435
developer documentation.
@@ -38,9 +39,8 @@ the following items:
3839
- An ``examples`` directory with a minimal quickstart example script. This
3940
script imports the package and prints the package version. It is also
4041
called by the unit test suite to ensure it always works.
41-
- A ``tests`` directory containing a basic unit test (using unittest) and
42-
a shell script that can be used to test a wheel distribution of the
43-
package.
42+
- A ``tests`` directory containing a basic unit test and a shell
43+
script that can be used to test a wheel distribution of the package.
4444
- A Github Actions continuous integration configuration.
4545
- A ``docs`` directory with pre-configured Sphinx documentation containing:
4646

0 commit comments

Comments
 (0)