elasticsearch-pydantic 0.1.0

Use the Elasticsearch DSL with Pydantic models.

🔍 elasticsearch-pydantic

Use the Elasticsearch DSL with Pydantic models.

This minimal library is for those who...

• ... want to benefit from Pydantic's extensive validation and type checking ecosystem,
• ... want the convenient and idiomatic persistence layer and query DSL of Elasticsearch DSL,
• ... and do not want to reimplement everything from scratch.

To interconnect the Elasticsearch DSL and Pydantic, we override a limited set of methods from the Elasticsearch Document and InnerDoc base classes with Pydantic's BaseModel functionality. Elasticsearch field types are inferred from the model's type annotations and can be overridden by using Annotated type hints.

Installation

Install the package from PyPI:

pip install elasticsearch-pydantic

Usage

TODO

Examples

More examples can be found in the examples directory.

Compatibility

This library works fine with any of the following Pip packages installed:

• elasticsearch8
• elasticsearch-dsl
• elasticsearch6-dsl
• elasticsearch7-dsl
• elasticsearch8-dsl

The elasticsearch-pydantic library will automatically detect which Elasticsearch DSL is installed.

Development

To build this package and contribute to its development you need to install the build, setuptools and wheel packages:

pip install build setuptools wheel

(On most systems, these packages are already pre-installed.)

Development installation

Install package and test dependencies:

pip install -e .[tests]

Testing

Verify your changes against the test suite to verify.

ruff check .  # Code format and LINT
mypy .        # Static typing
pytest .      # Unit tests

Please also add tests for your newly developed code.

Build wheels

Wheels for this package can be built with:

python -m build

Support

If you have any problems using this package, please file an issue. We're happy to help!

License

This repository is released under the MIT license.