Skip to main content

OData-Query

Documentation Status Code style: black

odata-query is a library that parses OData v4 filter strings, and can convert them to other forms such as Django Queries, SQLAlchemy Queries, or just plain SQL.

Installation

odata-query is available on pypi, so can be installed with the package manager of your choice:

pip install odata-query
# OR
poetry add odata-query
# OR
pipenv install odata-query

The package defines the following optional extra’s:

  • django: If you want to pin a compatible Django version.

  • sqlalchemy: If you want to pin a compatible SQLAlchemy version.

The following extra’s relate to the development of this library:

  • linting: The linting and code style tools.

  • testing: Packages for running the tests.

  • docs: For building the project documentation.

You can install extra’s by adding them between square brackets during installation:

pip install odata-query[sqlalchemy]

Quickstart

The most common use case is probably parsing an OData query string, and applying it to a query your ORM understands. For this purpose there is an all-in-one function: apply_odata_query.

Example for Django:

from odata_query.django import apply_odata_query

orm_query = MyModel.objects  # This can be a Manager or a QuerySet.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_query(orm_query, odata_query)
results = query.all()

Example for SQLAlchemy ORM:

from odata_query.sqlalchemy import apply_odata_query

orm_query = select(MyModel)  # This is any form of Query or Selectable.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_query(orm_query, odata_query)
results = session.execute(query).scalars().all()

Example for SQLAlchemy Core:

from odata_query.sqlalchemy import apply_odata_core

core_query = select(MyTable)  # This is any form of Query or Selectable.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_core(core_query, odata_query)
results = session.execute(query).scalars().all()

Advanced Usage

Not all use cases are as simple as that. Luckily, odata-query is modular and extendable. See the documentation for advanced usage or extending the library for other cases.

Contact

Got any questions or ideas? We’d love to hear from you. Check out our contributing guidelines for ways to offer feedback and contribute.

License

Copyright © Gorillini NV. All rights reserved.

Licensed under the MIT License.

Metadata

Release files for odata-query 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odata-query 0.10.1
File Size Uploaded Provenance Actions
odata_query-0.10.1.tar.gz 26.8 kB Without provenance Details for odata_query-0.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for odata-query 0.10.1
File Interpreter ABI Platform Actions
odata_query-0.10.1-py3-none-any.whl Python 3 none any Details for odata_query-0.10.1-py3-none-any.whl

Total release size: 61.8 kB

Release files / odata_query-0.10.1.tar.gz

Download URL odata_query-0.10.1.tar.gz
Size 26.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b8802c8bf1ed0fdea100abf215411f71b6752b128c6d9062eb9ae6ba34830d56
BLAKE2b-256 checksum
How to use checksums
4c68be10e72896da71b1e0aa20e69efac58aaacfbcd3498dec1aa5812f464c71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.11.11 Darwin/25.6.0

Release files / odata_query-0.10.1-py3-none-any.whl

Download URL odata_query-0.10.1-py3-none-any.whl
Size 35.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
410afa76da86568773ade366e512aeaf4f84682327e60ca376445bd2bc593799
BLAKE2b-256 checksum
How to use checksums
0af64c019b61745c5e6dc81f577d756f322a255e92652a13e8c3877ae6648561
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.11.11 Darwin/25.6.0

Security for odata-query 0.10.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page