Skip to main content

Sphinx Pandera

Project description

Sphinx extension for Pandera models

Description

This packages bridges pandera models with sphinx to generate documentation for your pandera models. It is based on a similar project for pydantic autodoc_pydantic.

Our vision is to have one place where you :

  1. describe
  2. validate
  3. document your data

Pandera already does step 1 and 2. Sphinx-pandera fills the documentation gap. This way, your pandera model is the single source of truth for your data.

Useful links

State of the project

This project is in alpha state, we welcome feature requests and contributions.

There might be some delays when answering issues and merge requests.

It has been initiated by the Mission data at the French National Authority for Health.

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

sphinx_pandera-0.0.2.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

sphinx_pandera-0.0.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_pandera-0.0.2.tar.gz.

File metadata

  • Download URL: sphinx_pandera-0.0.2.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.16 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for sphinx_pandera-0.0.2.tar.gz
Algorithm Hash digest
SHA256 787494e1c5c5261922256bb6471a683ec0d55dec48db0e50801c6910fd4efe20
MD5 bd55697d2dea7ee55680f7b4fd3db782
BLAKE2b-256 305832c51cce57a6c49bb30014745ee592c10288197e95a4d74ffdbdd3926857

See more details on using hashes here.

File details

Details for the file sphinx_pandera-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: sphinx_pandera-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.16 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for sphinx_pandera-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 afcaf9e6b2ae79d14f0a0dd793771a9fe097921ec3a3a94e283ab2270369179f
MD5 aeca58252eafe3ad098edb2d9b696fe8
BLAKE2b-256 e2367d190603bbd07f87c037b14358b774912263c3ffc9bb99dce30b6f13e977

See more details on using hashes here.

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