Skip to content

Commit 4b3c7d6

Browse files
authored
Update README.md
Substitute nox by Poe the Poet
1 parent e74474b commit 4b3c7d6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,10 @@
6060
<!-- ABOUT THE PROJECT -->
6161
## About The Project
6262

63-
Python template with some awesome tools to quickstart any Python project.
63+
Python template with some awesome tools to quickstart a Python project with the industry best practices.
6464
It includes automatic generation of API documentation, tests using PyTest, code coverage,
65-
Flake8 linting to enforce standardized Python coding, automatic UML diagrams generation using PyReverse,
66-
virtual environments using Poetry, workflow automation using Nox,
67-
code formating using black and a standard Dockerfile to kickstart your project using the power of Docker containers and much more.
65+
Flake8 linting to enforce standardized Python coding, virtual environments using Poetry, workflow automation using Poe the Poet,
66+
code formatting using black and a space optimized Dockerfile to kickstart your project and run tests using the power of Docker containers.
6867

6968
All you need to do is to install [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/usage.html)!
7069

@@ -92,13 +91,14 @@ This Project depends on the following projects.
9291
cookiecutter https://github.com/nullhack/cookiecutter-python-base-project
9392
# move into your newly created project folder
9493
```
95-
2. Install nox
94+
2. Install Poe the Poet and Poetry
9695
```sh
97-
pip install --user --upgrade nox
96+
pip install --user --upgrade poethepoet poetry
9897
```
99-
3. Let nox do it's magic
98+
3. Let Poe do it's magic
10099
```sh
101-
nox
100+
poe install-dev
101+
poe test
102102
```
103103

104104
<p align="right">(<a href="#top">back to top</a>)</p>

0 commit comments

Comments
 (0)