Skip to content

Commit 481f865

Browse files
committed
chore: Improve readme md
1 parent 5a0754e commit 481f865

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,19 @@
77
2. Run command 'docker-compose up --build'
88

99
3. Enter [here](http://0.0.0.0:8000/docs)
10+
11+
## Testing
12+
13+
1. Create a virtual enviroment with command 'python3 -m venv tutorial-env' and python 3.10
14+
15+
2. Execute the enviroment with command 'source tutorial-env/bin/activate'
16+
17+
3. Install production requirements with command 'pip install -r requirements.txt'
18+
19+
4. Install develop requirements with command 'pip install -r requirements_dev.txt'
20+
21+
5. Run tests with command 'pytest test/'
22+
23+
## Analyse code
24+
25+
You can analyse your code best practices after install develop requirements with commands 'mypy app' and 'prospector' in the root folder of the project.

setup.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,27 @@
66

77
setup(
88
name = 'fastapi_mongodb_template',
9-
version = '0.0.6',
9+
version = '1.1.0',
1010
author = 'Antonio Germán Márquez Trujillo',
1111
author_email = '[email protected]',
1212
description = 'Template using FastAPI and MongoDB',
1313
long_description = long_description,
1414
long_description_content_type = 'text/markdown',
1515
url = 'https://github.com/GermanMT/fastapi_mongodb_template',
1616
classifiers = [
17-
'Programming Language :: Python :: 3',
18-
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
19-
'Operating System :: OS Independent',
17+
'Programming Language :: Python :: 3.10'
2018
],
2119
python_requires = '>=3.10',
2220
install_requires = [
2321
'wheel==0.37.1',
2422
'uvicorn==0.18.2',
2523
'fastapi==0.79.0',
24+
'email-validator==1.3.0',
2625
'pymongo==4.2.0',
2726
'motor==3.0.0',
2827
'motor-stubs==1.7.1',
2928
'python-dotenv==0.20.0',
30-
'requests==2.28.1'
29+
'requests==2.28.1',
3130
'types-requests==2.28.8',
3231
'types-setuptools==63.4.0'
3332
],

0 commit comments

Comments
 (0)