Skip to content

Commit 3470565

Browse files
authored
Update README.md
Updating documentation, removing nox and include Poe the Poet as main dependency for development
1 parent 4b3c7d6 commit 3470565

File tree

1 file changed

+21
-34
lines changed

1 file changed

+21
-34
lines changed

{{cookiecutter.project_slug}}/README.md

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -69,40 +69,24 @@
6969

7070
{{cookiecutter.project_short_description}}
7171

72-
### UML Diagrams
73-
74-
#### Packages and Modules
75-
76-
<a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png">
77-
<img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png" alt="uml-diagram-packages">
78-
</a>
79-
80-
---
81-
82-
#### Classes
83-
84-
<a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png">
85-
<img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png" alt="uml-diagram-classes">
86-
</a>
87-
8872
<p align="right">(<a href="#top">back to top</a>)</p>
8973

9074
<!-- GETTING STARTED -->
9175
## Getting Started
9276

93-
To get a local copy up and running follow these simple steps.
77+
To run this project locally, you will need to install the prerequisites and follow the installation section
9478

9579
### Prerequisites
9680

9781
This Project depends on the following projects.
98-
* poetry
82+
* Poetry
9983
```sh
10084
pip install --user --upgrade poetry
10185
```
10286

103-
* nox
87+
* Poe the Poet
10488
```sh
105-
pip install --user --upgrade nox
89+
pip install --user --upgrade poethepoet
10690
```
10791

10892
### Installation
@@ -112,17 +96,17 @@ This Project depends on the following projects.
11296
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
11397
cd {{cookiecutter.project_slug}}
11498
```
115-
2. Install nox
99+
2. Install Poe the Poet and Poetry
116100
```sh
117-
pip install --user --upgrade nox
101+
pip install --user --upgrade poethepoet poetry
118102
```
119-
3. Install pre-commit and poetry
103+
3. Install requirements for development
120104
```sh
121-
nox -s install-dev
105+
poe install-dev
122106
```
123107
4. Run tests
124108
```sh
125-
nox -s tests
109+
poe test
126110
```
127111

128112
<p align="right">(<a href="#top">back to top</a>)</p>
@@ -134,30 +118,33 @@ This Project depends on the following projects.
134118

135119
Some useful examples of how this project can be used:
136120

137-
* Install and run pre-commit checks
121+
* Install requirements
138122
```sh
139-
nox
123+
poe install-dev
140124
```
141125

142126
* Run tests
143127
```sh
144-
nox -s tests
128+
poe test
145129
```
146130

147-
* Run code lint
131+
* Generate API documentation
148132
```sh
149-
nox -s lint
133+
poe doc
150134
```
151135

152-
* Generate API documentation
136+
* Build a docker image for tests
153137
```sh
154-
nox -s api-docs
138+
poe docker-build --target test --build-tag 3.10-alpine
139+
docker run -ti --rm {{cookiecutter.package_name}}:test-3.10-alpine
155140
```
156141

157-
* Run pre-commit checks
142+
* Build a docker image to run the root files only without running any test
158143
```sh
159-
nox -s pre-commit
144+
poe docker-build --target prod --build-tag 3.10-alpine --no-test
145+
docker run -ti --rm {{cookiecutter.package_name}}:prod-3.10-alpine
160146
```
147+
161148

162149
_For more examples, please refer to the [Documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/api/{{cookiecutter.project_slug}}/index.html)_
163150

0 commit comments

Comments
 (0)