|
60 | 60 | <!-- ABOUT THE PROJECT --> |
61 | 61 | ## About The Project |
62 | 62 |
|
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. |
64 | 64 | 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. |
68 | 67 |
|
69 | 68 | All you need to do is to install [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/usage.html)! |
70 | 69 |
|
@@ -92,13 +91,14 @@ This Project depends on the following projects. |
92 | 91 | cookiecutter https://github.com/nullhack/cookiecutter-python-base-project |
93 | 92 | # move into your newly created project folder |
94 | 93 | ``` |
95 | | -2. Install nox |
| 94 | +2. Install Poe the Poet and Poetry |
96 | 95 | ```sh |
97 | | - pip install --user --upgrade nox |
| 96 | + pip install --user --upgrade poethepoet poetry |
98 | 97 | ``` |
99 | | -3. Let nox do it's magic |
| 98 | +3. Let Poe do it's magic |
100 | 99 | ```sh |
101 | | - nox |
| 100 | + poe install-dev |
| 101 | + poe test |
102 | 102 | ``` |
103 | 103 |
|
104 | 104 | <p align="right">(<a href="#top">back to top</a>)</p> |
|
0 commit comments