Skip to main content

FastAPI filter

Project description

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

https://user-images.githubusercontent.com/950449/176737541-0e36b72f-38e2-4368-abfa-8bbc0c82e8ae.mp4

Order by

https://user-images.githubusercontent.com/950449/176747056-ea82d6b9-cb3b-43eb-aec7-96ba0bc79e8b.mp4

Contribution

You can run tests with pytest.

pip install poetry
poetry install --extras all
pytest
arthur_Arthurs-MacBook-Pro-2___code_fastapi-filter

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_filter-1.1.0.tar.gz (9.0 kB view hashes)

Uploaded Source

Built Distribution

fastapi_filter-1.1.0-py3-none-any.whl (9.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