Skip to main content

Utils for fastapi based services.

Project description

coverage PyPI version fury.io PyPI pyversions Documentation Status MIT License Powered by Dephell

Installation

pip install fastapi-serviceutils

Usage

For more details and usage see: readthedocs

Development

Getting started

After cloning the repository initialize the development environment using:

make init

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

poetry shell

Note:

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

poetry shell

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

Documentation

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.

Tests

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.

Files for fastapi-serviceutils, version 2.1.0
Filename, size File type Python version Upload date Hashes
Filename, size fastapi_serviceutils-2.1.0-py3-none-any.whl (23.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size fastapi_serviceutils-2.1.0.tar.gz (28.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page