Skip to main content

Utils for fastapi based services.

Project description

coverage PyPI version PyPI pyversions Documentation Status MIT License Powered by Dephell


pip install fastapi-serviceutils


For more details and usage see: readthedocs


Getting started

After cloning the repository initialize the development environment using:

make init

This will create the dev environment exampleservice/dev. Activate it using:

dephell venv shell --env devs


Make sure to always activate the environment when you start working on the project in a new terminal using

dephell venv shell --env devs

ATTENTION: the environment should also be activated before using make.

Updating dependencies

After each change in dependencies defined at pyproject.toml run the following to ensure the environment-definition and lock-file are up to date:

make update

Checking with linters and checkers

To run all pre-commit-hooks manually run:

make check

Info about project-state

To show summary about project run:

make info


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:

make docs

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:

make tests

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_serviceutils-1.0.0.tar.gz (13.5 kB view hashes)

Uploaded Source

Built Distribution

fastapi_serviceutils-1.0.0-py3-none-any.whl (15.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page