Utils for fastapi based services.

Last update: Nov 25, 2022

Related tags

Overview

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

The template for building scalable web APIs based on FastAPI, Tortoise ORM and other.

FastAPI and Tortoise ORM. Powerful but simple template for web APIs w/ FastAPI (as web framework) and Tortoise-ORM (for working via database without h

95 Jan 8, 2023

🐞 A debug toolbar for FastAPI based on the original django-debug-toolbar. 🐞

Debug Toolbar 🐞 A debug toolbar for FastAPI based on the original django-debug-toolbar. 🐞 Swagger UI & GraphQL are supported. Documentation: https:/

74 Dec 30, 2022

Github timeline htmx based web app rewritten from Common Lisp to Python FastAPI

python-fastapi-github-timeline Rewrite of Common Lisp htmx app _cl-github-timeline into Python using FastAPI. This project tries to prove, that with h

4 Mar 25, 2022

Basic fastapi blockchain - An api based blockchain with full functionality

1 Nov 27, 2021

Redis-based rate-limiting for FastAPI

6 Nov 14, 2022

A dynamic FastAPI router that automatically creates CRUD routes for your models

⚡ Create CRUD routes with lighting speed ⚡ A dynamic FastAPI router that automatically creates CRUD routes for your models

950 Jan 8, 2023

Adds simple SQLAlchemy support to FastAPI

FastAPI-SQLAlchemy FastAPI-SQLAlchemy provides a simple integration between FastAPI and SQLAlchemy in your application. It gives access to useful help

465 Jan 7, 2023

Opinionated set of utilities on top of FastAPI

FastAPI Contrib Opinionated set of utilities on top of FastAPI Free software: MIT license Documentation: https://fastapi-contrib.readthedocs.io. Featu

543 Jan 5, 2023

Reusable utilities for FastAPI

Reusable utilities for FastAPI Documentation: https://fastapi-utils.davidmontague.xyz Source Code: https://github.com/dmontagu/fastapi-utils FastAPI i

1.3k Jan 4, 2023

Comments

ERROR InstallationError: Invalid requirement: 'app/main.py'

Bootstrapped example app with following results

dephell inspect venv

results in:

{
  "activate": "/Users/<devcomp>/.local/share/dephell/venvs/<my_app>-IrrL/main/bin/activate.fish",
  "bin": "/Users/<devcomp>/.local/share/dephell/venvs/<my_app>-IrrL/main/bin",
  "exists": true,
  "lib": "/Users/<devcomp>/.local/share/dephell/venvs/<my_app>-IrrL/main/lib/python3.7/site-packages",
  "lib_size": "9.87Mb",
  "project": "/Users/<devcomp>/<Apps Dir>/<my_app>",
  "python": "/Users/<devcomp>/.local/share/dephell/venvs/<my_app>-IrrL/main/bin/python",
  "venv": "/Users/<devcomp>/.local/share/dephell/venvs/<my_app>-IrrL/main"
}

issue is as follows:

dephell venv run app/main.py
WARNING executable is not found in venv, trying to install... (executable=app/main.py)
ERROR InstallationError: Invalid requirement: 'app/main.py' (from line 1 of /var/folders/mr/3ctw8jvj4jdfk_sznlwnhv7m0000gn/T/tmphv2x_qlu)
Hint: It looks like a path. File 'app/main.py' does not exist.

opened by phyxavier 7

create_service command git error

after installing fastapi_serviceutils I try running the following command,

create_service -n exampleservice -p 9999 -a "John Doe" -e [email protected] -ep example -o /Documents

I get the following error message,

[email protected] ~ % create_service -n exampleservice -p 9999 -a "John Doe" -e [email protected] -ep example -o /Documents 
Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.9/bin/create_service", line 8, in <module>
    sys.exit(main())
  File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/fastapi_serviceutils/cli/create_service.py", line 107, in main
    filepath = clone(
  File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/cookiecutter/vcs.py", line 101, in clone
    subprocess.check_output(
  File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/subprocess.py", line 424, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/subprocess.py", line 528, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['git', 'clone', 'ssh://[email protected]/skallfass/fastapi_serviceutils_template.git']' returned non-zero exit status 128.

I simply followed up the following guideline https://fastapi-serviceutils.readthedocs.io/en/latest/exampleservice.html#creating-new-service

could anyone please help resolving this issue? many thanks

opened by ghost 0

Error: pg_config executable not found.

Hi there, Great idea for providing all of this together, although I think it's possibly a little too opinionated for general use. But it's really well laid out. Nice job!

Somewhere in the setup.py it expects the postgres binary to be available. I hit this error when it was not.

Thanks!

opened by philwinder 1

Releases(2.1.0)

2.1.0(Dec 7, 2019)
updated dependencies

fastapi => now pydantic >=1 is used

loguru => usage of alpine based images now possible

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-2.1.0-py3-none-any.whl(22.42 KB)
fastapi_serviceutils-2.1.0.tar.gz(27.76 KB)
2.0.1(Nov 25, 2019)
bugfix: create_service now uses correct repo-url

bugfix: fixed wrong usage of extras inside pyproject.toml and setup.py

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-2.0.1-py3-none-any.whl(22.42 KB)
fastapi_serviceutils-2.0.1.tar.gz(20.19 KB)
2.0.0(Nov 10, 2019)
includes easier usage of external_resources (databases and services)

bugfix in logger (previously wrong function was declared as source of log-message)

updated documentation with more details and an additional exampleservice-section

now mainly using poetry. dephell is now used for package creation

add additional tests for previously untested parts

added function for easier usage of versioned endpoints

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-2.0.0-py3-none-any.whl(22.46 KB)
fastapi_serviceutils-2.0.0.tar.gz(27.82 KB)
1.0.0(Oct 24, 2019)

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-1.0.0-py3-none-any.whl(15.55 KB)
fastapi_serviceutils-1.0.0.tar.gz(13.17 KB)
0.3.0(Oct 22, 2019)

Also updated documentation.
Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-0.3.0-py3-none-any.whl(16.16 KB)
fastapi_serviceutils-0.3.0.tar.gz(13.60 KB)
0.2.1(Oct 20, 2019)

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-0.2.1-py3-none-any.whl(26.73 KB)
fastapi_serviceutils-0.2.1.tar.gz(17.55 KB)
0.2.0(Oct 20, 2019)

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-0.2.0-py3-none-any.whl(26.40 KB)
fastapi_serviceutils-0.2.0.tar.gz(17.58 KB)
0.1.0(Oct 20, 2019)

Source code(tar.gz)
Source code(zip)
fastapi_serviceutils-0.1.0-py3-none-any.whl(26.35 KB)
fastapi_serviceutils-0.1.0.tar.gz(16.70 KB)

Owner

Simon Kallfass

GitHub Repository

REST API with FastAPI and PostgreSQL

REST API with FastAPI and PostgreSQL To have the same data in db: create table CLIENT_DATA (id SERIAL PRIMARY KEY, fullname VARCHAR(50) NOT NULL,email

1 Nov 11, 2021

FastAPI application and service structure for a more maintainable codebase

Abstracting FastAPI Services See this article for more information: https://camillovisini.com/article/abstracting-fastapi-services/ Poetry poetry inst

309 Jan 04, 2023

API using python and Fastapi framework

Welcome 👋 CFCApi is a API DEVELOPMENT PROJECT UNDER CODE FOR COMMUNITY ! Project Walkthrough 🚀 CFCApi run on Python using FASTapi Framework Docs The

7 Jan 02, 2023

This project shows how to serve an ONNX-optimized image classification model as a web service with FastAPI, Docker, and Kubernetes.

Deploying ML models with FastAPI, Docker, and Kubernetes By: Sayak Paul and Chansung Park This project shows how to serve an ONNX-optimized image clas

104 Dec 23, 2022

Middleware for Starlette that allows you to store and access the context data of a request. Can be used with logging so logs automatically use request headers such as x-request-id or x-correlation-id.

starlette context Middleware for Starlette that allows you to store and access the context data of a request. Can be used with logging so logs automat

300 Dec 26, 2022

Utils for fastapi based services.

Related tags

Overview

Installation

Usage

Development

Getting started

Updating dependencies

Checking with linters and checkers

Info about project-state

Documentation

Tests

You might also like...

The template for building scalable web APIs based on FastAPI, Tortoise ORM and other.

🐞 A debug toolbar for FastAPI based on the original django-debug-toolbar. 🐞

Github timeline htmx based web app rewritten from Common Lisp to Python FastAPI

Basic fastapi blockchain - An api based blockchain with full functionality

Redis-based rate-limiting for FastAPI

A dynamic FastAPI router that automatically creates CRUD routes for your models

Adds simple SQLAlchemy support to FastAPI

Opinionated set of utilities on top of FastAPI

Reusable utilities for FastAPI

Comments

ERROR InstallationError: Invalid requirement: 'app/main.py'

create_service command git error

Error: pg_config executable not found.

Releases(2.1.0)

2.1.0(Dec 7, 2019)

2.0.1(Nov 25, 2019)

2.0.0(Nov 10, 2019)

1.0.0(Oct 24, 2019)

0.3.0(Oct 22, 2019)

0.2.1(Oct 20, 2019)

0.2.0(Oct 20, 2019)

0.1.0(Oct 20, 2019)

Owner

Simon Kallfass

REST API with FastAPI and PostgreSQL

FastAPI application and service structure for a more maintainable codebase

API using python and Fastapi framework

This project shows how to serve an ONNX-optimized image classification model as a web service with FastAPI, Docker, and Kubernetes.

FastAPI Project Template

MS Graph API authentication example with Fast API

A dynamic FastAPI router that automatically creates CRUD routes for your models

MQTT FastAPI Wrapper With Python

Opinionated set of utilities on top of FastAPI

Basic fastapi blockchain - An api based blockchain with full functionality

fastapi-admin2 is an upgraded fastapi-admin, that supports ORM dialects, true Dependency Injection and extendability

Easy and secure implementation of Azure AD for your FastAPI APIs 🔒

🐞 A debug toolbar for FastAPI based on the original django-debug-toolbar. 🐞

The template for building scalable web APIs based on FastAPI, Tortoise ORM and other.

A simple example of deploying FastAPI as a Zeit Serverless Function

Voucher FastAPI

Regex Converter for Flask URL Routes

Flood Detection with Google Earth Engine

Socket.IO integration for Flask applications.

Middleware for Starlette that allows you to store and access the context data of a request. Can be used with logging so logs automatically use request headers such as x-request-id or x-correlation-id.