pandera-catalog 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pandera_catalog-0.2.0/.github/workflows/build_and_test.yml +84 -0
- pandera_catalog-0.2.0/.github/workflows/docs_to_gh_pages.yml +46 -0
- pandera_catalog-0.2.0/.github/workflows/publish_to_pypi.yml +27 -0
- pandera_catalog-0.2.0/.gitignore +219 -0
- pandera_catalog-0.2.0/.python-version +1 -0
- pandera_catalog-0.2.0/LICENSE +21 -0
- pandera_catalog-0.2.0/PKG-INFO +104 -0
- pandera_catalog-0.2.0/README.md +81 -0
- pandera_catalog-0.2.0/badges/.gitkeep +0 -0
- pandera_catalog-0.2.0/coverage.json +1 -0
- pandera_catalog-0.2.0/docs/_static/badges/.gitkeep +0 -0
- pandera_catalog-0.2.0/docs/_static/badges/coverage.svg +21 -0
- pandera_catalog-0.2.0/docs/_static/branding/pandera-catalog.svg +48 -0
- pandera_catalog-0.2.0/docs/_static/custom.css +4 -0
- pandera_catalog-0.2.0/docs/_templates/.gitkeep +0 -0
- pandera_catalog-0.2.0/docs/api/modules.rst +14 -0
- pandera_catalog-0.2.0/docs/conf.py +70 -0
- pandera_catalog-0.2.0/docs/developer_testing.rst +60 -0
- pandera_catalog-0.2.0/docs/index.rst +23 -0
- pandera_catalog-0.2.0/docs/user_guide/00_catalog_basics.rst +43 -0
- pandera_catalog-0.2.0/docs/user_guide/01_schema_projections.rst +41 -0
- pandera_catalog-0.2.0/docs/user_guide/02_loading_schemas_from_yaml.rst +14 -0
- pandera_catalog-0.2.0/docs/user_guide/03_schema_lifecycle.rst +12 -0
- pandera_catalog-0.2.0/docs/user_guide/index.rst +12 -0
- pandera_catalog-0.2.0/examples/01_basic_catalog_usage.py +106 -0
- pandera_catalog-0.2.0/examples/02_load_schema_from_yaml.py +87 -0
- pandera_catalog-0.2.0/examples/03_schema_projection.py +58 -0
- pandera_catalog-0.2.0/examples/README.rst +4 -0
- pandera_catalog-0.2.0/pandera_catalog/__init__.py +19 -0
- pandera_catalog-0.2.0/pandera_catalog/catalog.py +324 -0
- pandera_catalog-0.2.0/pandera_catalog/schemas.py +77 -0
- pandera_catalog-0.2.0/pandera_catalog/types.py +59 -0
- pandera_catalog-0.2.0/pandera_catalog/utils/__init__.py +3 -0
- pandera_catalog-0.2.0/pyproject.toml +71 -0
- pandera_catalog-0.2.0/scratch/.gitkeep +0 -0
- pandera_catalog-0.2.0/tests/conftest.py +40 -0
- pandera_catalog-0.2.0/tests/test_catalog.py +358 -0
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
name: "Run Tests with uv"
|
|
2
|
+
|
|
3
|
+
permissions:
|
|
4
|
+
contents: write
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
- 'release/*'
|
|
11
|
+
pull_request:
|
|
12
|
+
branches:
|
|
13
|
+
- main
|
|
14
|
+
- 'release/*'
|
|
15
|
+
workflow_dispatch:
|
|
16
|
+
|
|
17
|
+
jobs:
|
|
18
|
+
build:
|
|
19
|
+
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
strategy:
|
|
22
|
+
matrix:
|
|
23
|
+
python-version: [ "3.11", "3.12", "3.13" ]
|
|
24
|
+
|
|
25
|
+
steps:
|
|
26
|
+
- uses: actions/checkout@v4
|
|
27
|
+
|
|
28
|
+
- name: Install uv
|
|
29
|
+
uses: astral-sh/setup-uv@v5
|
|
30
|
+
with:
|
|
31
|
+
python-version: ${{ matrix.python-version }}
|
|
32
|
+
|
|
33
|
+
- name: Install dependencies
|
|
34
|
+
run: uv sync --all-extras --dev
|
|
35
|
+
|
|
36
|
+
- name: Test with pytest
|
|
37
|
+
run: uv run pytest -m "not gui"
|
|
38
|
+
|
|
39
|
+
coverage-badge:
|
|
40
|
+
runs-on: ubuntu-latest
|
|
41
|
+
needs: build
|
|
42
|
+
steps:
|
|
43
|
+
- uses: actions/checkout@v4
|
|
44
|
+
|
|
45
|
+
- name: Install uv
|
|
46
|
+
uses: astral-sh/setup-uv@v5
|
|
47
|
+
with:
|
|
48
|
+
python-version: "3.13"
|
|
49
|
+
|
|
50
|
+
- name: Install dependencies
|
|
51
|
+
run: uv sync --all-extras --dev
|
|
52
|
+
|
|
53
|
+
- name: Generate coverage report
|
|
54
|
+
run: |
|
|
55
|
+
uv run coverage run -m pytest -m "not gui"
|
|
56
|
+
uv run coverage report --fail-under=60
|
|
57
|
+
uv run coverage xml
|
|
58
|
+
|
|
59
|
+
- name: Generate coverage badge
|
|
60
|
+
uses: tj-actions/coverage-badge-py@v2
|
|
61
|
+
with:
|
|
62
|
+
output: badges/coverage.svg
|
|
63
|
+
|
|
64
|
+
- name: Ensure destination directory and copy badge
|
|
65
|
+
run: |
|
|
66
|
+
mkdir -p docs/_static/badges
|
|
67
|
+
cp badges/coverage.svg docs/_static/badges/coverage.svg
|
|
68
|
+
|
|
69
|
+
- name: Upload coverage badge
|
|
70
|
+
uses: actions/upload-artifact@v4
|
|
71
|
+
with:
|
|
72
|
+
name: coverage-badge
|
|
73
|
+
path: docs/source/_static/badges/coverage.svg
|
|
74
|
+
|
|
75
|
+
- name: Commit and push coverage badge
|
|
76
|
+
if: github.event_name == 'push'
|
|
77
|
+
run: |
|
|
78
|
+
git config --global user.name "github-actions[bot]"
|
|
79
|
+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
|
80
|
+
git add docs/_static/badges/coverage.svg
|
|
81
|
+
git commit -m "Update coverage badge [skip ci]" || echo "No changes to commit"
|
|
82
|
+
git push
|
|
83
|
+
env:
|
|
84
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
name: "Build and Publish Docs to GitHub Pages"
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
paths:
|
|
5
|
+
- 'examples/*.py'
|
|
6
|
+
- 'docs/**'
|
|
7
|
+
- 'README.md'
|
|
8
|
+
pull_request:
|
|
9
|
+
paths:
|
|
10
|
+
- 'docs/**'
|
|
11
|
+
- 'examples/*.py'
|
|
12
|
+
- 'README.md'
|
|
13
|
+
workflow_dispatch:
|
|
14
|
+
|
|
15
|
+
permissions:
|
|
16
|
+
contents: write
|
|
17
|
+
jobs:
|
|
18
|
+
docs:
|
|
19
|
+
runs-on: ubuntu-latest
|
|
20
|
+
steps:
|
|
21
|
+
- uses: actions/checkout@v4
|
|
22
|
+
|
|
23
|
+
- name: Install uv
|
|
24
|
+
uses: astral-sh/setup-uv@v5
|
|
25
|
+
with:
|
|
26
|
+
python-version: "3.13"
|
|
27
|
+
|
|
28
|
+
# - name: Install graphviz
|
|
29
|
+
# run: |
|
|
30
|
+
# sudo apt-get update
|
|
31
|
+
# sudo apt-get install -y graphviz
|
|
32
|
+
|
|
33
|
+
- name: Install dependencies
|
|
34
|
+
run: uv sync --all-extras --dev
|
|
35
|
+
|
|
36
|
+
- name: Sphinx build
|
|
37
|
+
run: uv run sphinx-build docs docs/_build
|
|
38
|
+
|
|
39
|
+
- name: Deploy
|
|
40
|
+
if: github.ref == 'refs/heads/main'
|
|
41
|
+
uses: peaceiris/actions-gh-pages@v3
|
|
42
|
+
with:
|
|
43
|
+
publish_branch: gh-pages
|
|
44
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
45
|
+
publish_dir: docs/_build/
|
|
46
|
+
force_orphan: true
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# This workflow will upload a Python Package using uv when a release is created
|
|
2
|
+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
|
|
3
|
+
|
|
4
|
+
name: Upload Python Package
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
release:
|
|
8
|
+
types: [published]
|
|
9
|
+
workflow_dispatch:
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
id-token: write
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
deploy:
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
- name: Install uv
|
|
21
|
+
uses: astral-sh/setup-uv@v5
|
|
22
|
+
with:
|
|
23
|
+
python-version: "3.13"
|
|
24
|
+
- name: Build package
|
|
25
|
+
run: uv build
|
|
26
|
+
- name: Publish package
|
|
27
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
219
|
+
/docs/sg_execution_times.rst
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.13
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Greg Elphick
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pandera-catalog
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: A database-backed catalog for defining and managing Pandera schemas.
|
|
5
|
+
Author-email: Greg Elphick <11791585+elphick@users.noreply.github.com>
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
11
|
+
Requires-Python: <3.14,>=3.11
|
|
12
|
+
Requires-Dist: pandas>=2.0
|
|
13
|
+
Requires-Dist: pandera>=0.19
|
|
14
|
+
Requires-Dist: pyyaml>=6.0
|
|
15
|
+
Provides-Extra: all
|
|
16
|
+
Requires-Dist: plotly<7,>=6.0; extra == 'all'
|
|
17
|
+
Requires-Dist: pydantic>=2.0; extra == 'all'
|
|
18
|
+
Provides-Extra: schema
|
|
19
|
+
Requires-Dist: pydantic>=2.0; extra == 'schema'
|
|
20
|
+
Provides-Extra: viz
|
|
21
|
+
Requires-Dist: plotly<7,>=6.0; extra == 'viz'
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
|
|
24
|
+
<h1 style="display: inline-flex; align-items: center; gap: 0.4rem; margin: 0;">
|
|
25
|
+
<img src="https://raw.githubusercontent.com/elphick/pandera-catalog/main/docs/_static/branding/pandera-catalog.svg" alt="pandera-catalog logo" width="72" style="display: block; margin-top: 20px;" />
|
|
26
|
+
<span>pandera-catalog</span>
|
|
27
|
+
</h1>
|
|
28
|
+
|
|
29
|
+
[](https://github.com/elphick/pandera-catalog/actions/workflows/build_and_test.yml)
|
|
30
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
31
|
+
|
|
32
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
33
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
34
|
+
[](https://github.com/elphick/pandera-catalog/issues)
|
|
35
|
+
|
|
36
|
+
## Overview
|
|
37
|
+
|
|
38
|
+
`pandera-catalog` is a Python package that provides a database-backed catalog for registering, looking up, and
|
|
39
|
+
managing [Pandera](https://pandera.readthedocs.io/) schemas. It is designed to grow into a SQLAlchemy-connected
|
|
40
|
+
(SQLite initially) registry of schema entries, validation rules, and schema metadata — keeping schemas
|
|
41
|
+
organized, discoverable, and version-aware.
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
Install the base package:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install pandera-catalog
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Or with `uv`:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
uv add pandera-catalog
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Install optional extras for schema validation helpers using Pydantic:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
pip install "pandera-catalog[schema]"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Quick Usage
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
import pandera.pandas as pa
|
|
67
|
+
from pandera_catalog import PanderaCatalog
|
|
68
|
+
|
|
69
|
+
# Create a catalog
|
|
70
|
+
catalog = PanderaCatalog()
|
|
71
|
+
|
|
72
|
+
# Define a schema
|
|
73
|
+
schema = pa.DataFrameSchema(
|
|
74
|
+
columns={
|
|
75
|
+
"id": pa.Column(int),
|
|
76
|
+
"value": pa.Column(float, pa.Check.greater_than(0)),
|
|
77
|
+
}
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
# Register the schema
|
|
81
|
+
catalog.register("my_schema", schema)
|
|
82
|
+
|
|
83
|
+
# Look up the schema
|
|
84
|
+
retrieved = catalog.get("my_schema")
|
|
85
|
+
print(retrieved)
|
|
86
|
+
|
|
87
|
+
# List all registered schemas
|
|
88
|
+
print(catalog.list())
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Loading schemas from YAML
|
|
92
|
+
|
|
93
|
+
```python
|
|
94
|
+
from pathlib import Path
|
|
95
|
+
from pandera_catalog import PanderaCatalog
|
|
96
|
+
from pandera_catalog.schemas import load_schema_from_yaml
|
|
97
|
+
|
|
98
|
+
catalog = PanderaCatalog()
|
|
99
|
+
schema = load_schema_from_yaml(Path("schemas/my_schema.yaml"))
|
|
100
|
+
catalog.register("my_schema", schema)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
See the [documentation](https://elphick.github.io/pandera-catalog/) and
|
|
104
|
+
[examples](examples/) for more detail.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
<h1 style="display: inline-flex; align-items: center; gap: 0.4rem; margin: 0;">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/elphick/pandera-catalog/main/docs/_static/branding/pandera-catalog.svg" alt="pandera-catalog logo" width="72" style="display: block; margin-top: 20px;" />
|
|
3
|
+
<span>pandera-catalog</span>
|
|
4
|
+
</h1>
|
|
5
|
+
|
|
6
|
+
[](https://github.com/elphick/pandera-catalog/actions/workflows/build_and_test.yml)
|
|
7
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
8
|
+
|
|
9
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
10
|
+
[](https://pypi.org/project/pandera-catalog/)
|
|
11
|
+
[](https://github.com/elphick/pandera-catalog/issues)
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
`pandera-catalog` is a Python package that provides a database-backed catalog for registering, looking up, and
|
|
16
|
+
managing [Pandera](https://pandera.readthedocs.io/) schemas. It is designed to grow into a SQLAlchemy-connected
|
|
17
|
+
(SQLite initially) registry of schema entries, validation rules, and schema metadata — keeping schemas
|
|
18
|
+
organized, discoverable, and version-aware.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
Install the base package:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pip install pandera-catalog
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Or with `uv`:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
uv add pandera-catalog
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Install optional extras for schema validation helpers using Pydantic:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install "pandera-catalog[schema]"
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Quick Usage
|
|
41
|
+
|
|
42
|
+
```python
|
|
43
|
+
import pandera.pandas as pa
|
|
44
|
+
from pandera_catalog import PanderaCatalog
|
|
45
|
+
|
|
46
|
+
# Create a catalog
|
|
47
|
+
catalog = PanderaCatalog()
|
|
48
|
+
|
|
49
|
+
# Define a schema
|
|
50
|
+
schema = pa.DataFrameSchema(
|
|
51
|
+
columns={
|
|
52
|
+
"id": pa.Column(int),
|
|
53
|
+
"value": pa.Column(float, pa.Check.greater_than(0)),
|
|
54
|
+
}
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
# Register the schema
|
|
58
|
+
catalog.register("my_schema", schema)
|
|
59
|
+
|
|
60
|
+
# Look up the schema
|
|
61
|
+
retrieved = catalog.get("my_schema")
|
|
62
|
+
print(retrieved)
|
|
63
|
+
|
|
64
|
+
# List all registered schemas
|
|
65
|
+
print(catalog.list())
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Loading schemas from YAML
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from pathlib import Path
|
|
72
|
+
from pandera_catalog import PanderaCatalog
|
|
73
|
+
from pandera_catalog.schemas import load_schema_from_yaml
|
|
74
|
+
|
|
75
|
+
catalog = PanderaCatalog()
|
|
76
|
+
schema = load_schema_from_yaml(Path("schemas/my_schema.yaml"))
|
|
77
|
+
catalog.register("my_schema", schema)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
See the [documentation](https://elphick.github.io/pandera-catalog/) and
|
|
81
|
+
[examples](examples/) for more detail.
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version": "5.5", "meta": {"version": "7.8.0", "timestamp": "2026-01-01T00:00:00.000000", "branch_coverage": true, "show_missing": true}, "files": {}, "totals": {"covered_lines": 0, "num_statements": 0, "percent_covered": 0.0, "percent_covered_display": "0%", "missing_lines": 0, "excluded_lines": 0, "num_branches": 0, "num_partial_branches": 0, "covered_branches": 0, "missing_branches": 0}}
|
|
File without changes
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">
|
|
3
|
+
<linearGradient id="b" x2="0" y2="100%">
|
|
4
|
+
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
|
5
|
+
<stop offset="1" stop-opacity=".1"/>
|
|
6
|
+
</linearGradient>
|
|
7
|
+
<mask id="a">
|
|
8
|
+
<rect width="99" height="20" rx="3" fill="#fff"/>
|
|
9
|
+
</mask>
|
|
10
|
+
<g mask="url(#a)">
|
|
11
|
+
<path fill="#555" d="M0 0h63v20H0z"/>
|
|
12
|
+
<path fill="#97CA00" d="M63 0h36v20H63z"/>
|
|
13
|
+
<path fill="url(#b)" d="M0 0h99v20H0z"/>
|
|
14
|
+
</g>
|
|
15
|
+
<g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
|
|
16
|
+
<text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
|
|
17
|
+
<text x="31.5" y="14">coverage</text>
|
|
18
|
+
<text x="80" y="15" fill="#010101" fill-opacity=".3">93%</text>
|
|
19
|
+
<text x="80" y="14">93%</text>
|
|
20
|
+
</g>
|
|
21
|
+
</svg>
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
<svg width="256" height="256" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg">
|
|
2
|
+
|
|
3
|
+
<!-- Correct orientation: flat top & bottom -->
|
|
4
|
+
<path
|
|
5
|
+
d="
|
|
6
|
+
M80,60
|
|
7
|
+
L176,60
|
|
8
|
+
L216,128
|
|
9
|
+
L176,196
|
|
10
|
+
L80,196
|
|
11
|
+
L40,128
|
|
12
|
+
Z"
|
|
13
|
+
fill="none"
|
|
14
|
+
stroke="#8DBF43"
|
|
15
|
+
stroke-width="40"
|
|
16
|
+
stroke-linejoin="round"
|
|
17
|
+
stroke-linecap="round"
|
|
18
|
+
/>
|
|
19
|
+
|
|
20
|
+
<!-- Fill core -->
|
|
21
|
+
<path
|
|
22
|
+
d="
|
|
23
|
+
M80,60
|
|
24
|
+
L176,60
|
|
25
|
+
L216,128
|
|
26
|
+
L176,196
|
|
27
|
+
L80,196
|
|
28
|
+
L40,128
|
|
29
|
+
Z"
|
|
30
|
+
fill="#8DBF43"
|
|
31
|
+
/>
|
|
32
|
+
|
|
33
|
+
<!-- Columns -->
|
|
34
|
+
<g transform="translate(74,76)">
|
|
35
|
+
<rect x="0" y="0" width="30" height="104" fill="#A9CF6A"/>
|
|
36
|
+
<rect x="39" y="0" width="30" height="104" fill="#D6EFA3"/>
|
|
37
|
+
<rect x="78" y="0" width="30" height="104" fill="#D6EFA3"/>
|
|
38
|
+
</g>
|
|
39
|
+
|
|
40
|
+
<!-- Check -->
|
|
41
|
+
<path
|
|
42
|
+
d="M78 130 L110 162 L182 92"
|
|
43
|
+
fill="none"
|
|
44
|
+
stroke="#1F2A1F"
|
|
45
|
+
stroke-width="14"
|
|
46
|
+
stroke-linecap="round"
|
|
47
|
+
stroke-linejoin="round"/>
|
|
48
|
+
</svg>
|
|
File without changes
|