Skip to content

arthurio/fastapi-filter

Repository files navigation

pypi downloads codecov Netlify Status CodeQL

FastAPI filter

Compatibility

Required:

  • Python: >=3.8, <4.0
  • Fastapi: >=0.100, <1.0
  • Pydantic: >=2.0.0, <3.0.0

Optional

  • MongoEngine: >=0.24.1, <0.28.0
  • SQLAlchemy: >=1.4.36, <2.1.0

Installation

# Basic version
pip install fastapi-filter

# With backends
pip install fastapi-filter[all]

# More selective
pip install fastapi-filter[sqlalchemy]
pip install fastapi-filter[mongoengine]

Documentation

Please visit: https://fastapi-filter.netlify.app/

Examples

Swagger UI

You can play with examples:

pip install poetry
poetry install
python examples/fastapi_filter_sqlalchemy.py

Filter

fastapi-filter.example.mp4

Order by

FastAPI.-.Swagger.UI.-.30.June.2022.mp4

Contribution

You can run tests with pytest.

pip install poetry
poetry install --extras all
pytest

arthur_Arthurs-MacBook-Pro-2___code_fastapi-filter