Pydantic Pynamodb

|PyPI| |Status| |Python Version| |License|

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/pydantic-pynamodb.svg :target: https://pypi.org/project/pydantic-pynamodb/ :alt: PyPI .. |Status| image:: https://img.shields.io/pypi/status/pydantic-pynamodb.svg :target: https://pypi.org/project/pydantic-pynamodb/ :alt: Status .. |Python Version| image:: https://img.shields.io/pypi/pyversions/pydantic-pynamodb :target: https://pypi.org/project/pydantic-pynamodb :alt: Python Version .. |License| image:: https://img.shields.io/pypi/l/pydantic-pynamodb :target: https://opensource.org/licenses/MIT :alt: License .. |Read the Docs| image:: https://img.shields.io/readthedocs/pydantic-pynamodb/latest.svg?label=Read%20the%20Docs :target: https://pydantic-pynamodb.readthedocs.io/ :alt: Read the documentation at https://pydantic-pynamodb.readthedocs.io/ .. |Tests| image:: https://github.com/andrewthetechie/pydantic-pynamodb/workflows/Tests/badge.svg :target: https://github.com/andrewthetechie/pydantic-pynamodb/actions?workflow=Tests :alt: Tests .. |Codecov| image:: https://codecov.io/gh/andrewthetechie/pydantic-pynamodb/branch/main/graph/badge.svg :target: https://app.codecov.io/gh/andrewthetechie/pydantic-pynamodb :alt: Codecov .. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white :target: https://github.com/pre-commit/pre-commit :alt: pre-commit .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Black

Wrap pynamo models in pydantic schemas to make them easy to work with in FastAPI.

Features

• TODO

Requirements

• pydantic
• pynamodb

Installation

You can install Pydantic Pynamodb via pip_ from PyPI_:

.. code:: console

$ pip install pydantic-pynamodb

Usage

Please see the Command-line Reference <Usage_>_ for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide_.

License

Distributed under the terms of the MIT license_, Pydantic Pynamodb is free and open source software.

Issues

If you encounter any problems, please file an issue_ along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

.. _@cjolowicz: https://github.com/cjolowicz .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _MIT license: https://opensource.org/licenses/MIT .. _PyPI: https://pypi.org/ .. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python .. _file an issue: https://github.com/andrewthetechie/pydantic-pynamodb/issues .. _pip: https://pip.pypa.io/ .. github-only .. _Contributor Guide: https://pydantic-pynamodb.readthedocs.io/en/latest/contributing.html .. _Usage: https://pydantic-pynamodb.readthedocs.io/en/latest/usage.html