Utils for fastapi based services.
pip install fastapi-serviceutils
For more details and usage see: readthedocs
After cloning the repository initialize the development environment using:
This will create the dev environment exampleservice/dev. Activate it using:
Make sure to always activate the environment when you start working on the project in a new terminal using
ATTENTION: the environment should also be activated before using make.
After each change in dependencies defined at pyproject.toml run the following to ensure the environment-definition and lock-file are up to date:
Checking with linters and checkers
To run all pre-commit-hooks manually run:
Info about project-state
To show summary about project run:
The project’s developer documentation is written using Sphinx.
The documentation sources can be found in the docs subdirectory.
The API-documentation is auto-generated from the docstrings of modules, classes, and functions. We’re using the Google docstring standard.
To generate the documentation, run:
The output for generated HTML files is in the docs/_build directory.
For testing we use pytest, for details see Pytest Docs. To run all tests:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size fastapi_serviceutils-2.0.0-py3-none-any.whl (23.0 kB)||File type Wheel||Python version py3||Upload date||Hashes View hashes|
|Filename, size fastapi_serviceutils-2.0.0.tar.gz (28.5 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for fastapi_serviceutils-2.0.0-py3-none-any.whl
Hashes for fastapi_serviceutils-2.0.0.tar.gz