Skip to content

Commit

Permalink
chore: Improve readme md
Browse files Browse the repository at this point in the history
  • Loading branch information
GermanMT committed Sep 23, 2022
1 parent 5a0754e commit 481f865
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,19 @@
2. Run command 'docker-compose up --build'

3. Enter [here](http://0.0.0.0:8000/docs)

## Testing

1. Create a virtual enviroment with command 'python3 -m venv tutorial-env' and python 3.10

2. Execute the enviroment with command 'source tutorial-env/bin/activate'

3. Install production requirements with command 'pip install -r requirements.txt'

4. Install develop requirements with command 'pip install -r requirements_dev.txt'

5. Run tests with command 'pytest test/'

## Analyse code

You can analyse your code best practices after install develop requirements with commands 'mypy app' and 'prospector' in the root folder of the project.
9 changes: 4 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,27 @@

setup(
name = 'fastapi_mongodb_template',
version = '0.0.6',
version = '1.1.0',
author = 'Antonio Germán Márquez Trujillo',
author_email = '[email protected]',
description = 'Template using FastAPI and MongoDB',
long_description = long_description,
long_description_content_type = 'text/markdown',
url = 'https://github.com/GermanMT/fastapi_mongodb_template',
classifiers = [
'Programming Language :: Python :: 3',
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3.10'
],
python_requires = '>=3.10',
install_requires = [
'wheel==0.37.1',
'uvicorn==0.18.2',
'fastapi==0.79.0',
'email-validator==1.3.0',
'pymongo==4.2.0',
'motor==3.0.0',
'motor-stubs==1.7.1',
'python-dotenv==0.20.0',
'requests==2.28.1'
'requests==2.28.1',
'types-requests==2.28.8',
'types-setuptools==63.4.0'
],
Expand Down

0 comments on commit 481f865

Please sign in to comment.