pvz-svc

FastApi + Mongo REST API wiki about Plants Vs Zombies videogame

Get started

Unix

Install poetry:

curl -sSL https://install.python-poetry.org | python3 -

Init repo:

poetry new pvz-svc

Create the virtual env folder:

mkdir .venv

Install all the dependencies in the project (clean-state):

poetry install

Install any dependency you need:

poetry add lib_here

Remove a dependency you don't need:

poetry remove lib_here

Update all (updatable) libs

poetry update

Set up

env

Activate using the command:

source .venv/bin/activate

Exit virtual env:

exit

or

deactivate

Advanced use cases

If multiple python versions are found in the operative system, then

• use pyenv to handle the versions
• if needed set the local python for this project, like

pyenv local 3.12.1

• you can confirm all good by checking

pyenv which python

• set the specific python version like

poetry env use $USER_HOME/.pyenv/versions/3.12.1/bin/python

• then install using commands like the ones in the previous section

Formatter

Using black as code formatter Can be used this way:

poetry run black .

Type checking

Using mypy for type checking Can be used this way:

poetry run mypy app tests

docs

Open {base_url}/docs while running to access swagger instance Open {base_url}/redoc while running to access redoc instance

launch

You might need to create a DB in Atlas Mongo, then please reference .env.sample, to create your own .env file with the relevant database info. Once ready you can do the following to launch:

uvicorn app:app --reload

test

pytest

automation

Run the server using the command on launch section Then open another console, activate the env and go to automation folder Once there run the tests using:

behave

You can see the console output with several features, scenarios and steps and its status as passed, failed or skipped.

Advanced use cases

If multiple python versions are found in the operative system, then

• use pyenv to handle the versions
• if needed set the local python for this project, like

pyenv local 3.12.1

• you can confirm all good by checking

pyenv which python

• set the specific python version like

poetry env use $USER_HOME/.pyenv/versions/3.12.1/bin/python

• then install using commands like the ones in the previous section

Formatter

Using black as code formatter Can be used this way:

poetry run black .

Type checking

Using mypy for type checking Can be used this way:

poetry run mypy app tests

api docs

• http://{host}:{port}/docs (swagger)
• http://{host}:{port}/redoc (redoc)

Web deployment

This app can be hosted in Railway, folder that helps with it is .ci folder.

List of cool technologies in use here

• FastApi
• poetry
• pymongo

License

MIT licensed.

Stay in touch

• Author - gal16v8d