patito 0.8.2__tar.gz → 0.8.4__tar.gz

patito-0.8.4/.github/workflows/ci.yml

@@ -0,0 +1,10 @@
+name: CI
+on: push
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - run: uv run nox

patito-0.8.4/.github/workflows/coverage.yml

@@ -0,0 +1,16 @@
+name: Coverage
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - run: uv run nox --sessions test-3.9
+      env:
+        CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

patito-0.8.4/.github/workflows/pre-commit.yml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1

patito-0.8.4/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v5
+      with:
+        python-version: |
+          3.9
+          3.10
+          3.11
+          3.12
+        architecture: x64
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - run: uv run nox
+    - run: uv build
+    - run: uv publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }}

patito-0.8.4/.gitignore

@@ -0,0 +1,137 @@
+# --- Custom ---
+.venv
+.nox
+
+# --- Auto-generated ---
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.vscode/
+.DS_Store

patito-0.8.4/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.0
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

patito-0.8.4/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - pandas
+        - docs
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+   configuration: docs/conf.py
+   # TODO: Set to true once patito.Field autodoc works with unicode type annotation
+   fail_on_warning: false
+
+formats: all

patito-0.8.4/.tool-versions

@@ -0,0 +1,2 @@
+python 3.12.2
+poetry 1.8.3

{patito-0.8.2 → patito-0.8.4}/PKG-INFO

@@ -1,35 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: patito
-Version: 0.8.2
+Version: 0.8.4
 Summary: A dataframe modelling library built on top of polars and pydantic.
-Home-page: https://github.com/JakobGM/patito
-License: MIT
-Keywords: validation,dataframe
-Author: Jakob Gerhard Martinussen
-Author-email: jakobgm@gmail.com
+Project-URL: Homepage, https://github.com/JakobGM/patito
+Project-URL: Repository, https://github.com/JakobGM/patito
+Project-URL: Documentation, https://patito.readthedocs.io
+Author-email: Jakob Gerhard Martinussen <jakobgm@gmail.com>, Thomas Aarholt <thomasaarholt@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dataframe,validation
 Requires-Python: >=3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: polars>=1.10.0
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: typing-extensions
 Provides-Extra: caching
-Provides-Extra: docs
+Requires-Dist: pyarrow>=5.0.0; extra == 'caching'
 Provides-Extra: pandas
-Requires-Dist: Sphinx (<7) ; extra == "docs"
-Requires-Dist: pandas ; extra == "pandas"
-Requires-Dist: polars (>=1.10.0)
-Requires-Dist: pyarrow (>=5.0.0) ; extra == "caching"
-Requires-Dist: pydantic (>=2.7.0)
-Requires-Dist: sphinx-autobuild ; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
-Requires-Dist: sphinx-rtd-theme ; extra == "docs"
-Requires-Dist: sphinx-toolbox ; extra == "docs"
-Requires-Dist: sphinxcontrib-mermaid ; extra == "docs"
-Requires-Dist: typing-extensions
-Project-URL: Documentation, https://patito.readthedocs.io
-Project-URL: Repository, https://github.com/JakobGM/patito
+Requires-Dist: pandas; extra == 'pandas'
 Description-Content-Type: text/markdown
 
 # <center><img height="30px" src="https://em-content.zobj.net/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
@@ -307,4 +294,3 @@ milk = products.get(pl.col("product_id") == 1)
 print(milk.url)
 # https://example.com/no/products/1-skimmed-milk
 ```
-

patito-0.8.4/docs/_static/css/custom.css

@@ -0,0 +1,134 @@
+:root {
+  --egg-yolk: #FFAA1E;
+  --cream: #FFF5E6;
+  --grapefruit: #FA3C0F;
+  --aubergine: #280F3C;
+  --lavender: #A573D2;
+}
+
+/* Unvisited links are Grapefruit colored */
+a {
+  color: var(--grapefruit);
+}
+
+/* Visited links are Grapefruit colored */
+a:visited {
+  color: var(--grapefruit);
+}
+
+/* Links become Aubergine colored on hover */
+a:hover {
+  color: var(--aubergine);
+  text-decoration: underline;
+}
+
+
+/* Left sidebar in Cream color */
+.wy-nav-side {
+  background-color: var(--cream);
+}
+
+/* All links in TOC tree as aubergine */
+.wy-menu-vertical li a {
+  color: var(--aubergine);
+}
+.wy-menu-vertical li.current a {
+  color: var(--aubergine);
+}
+
+/* The current navigation tree is highlighted in Grapefruit */
+.wy-menu-vertical li.current > a {
+  color: var(--grapefruit);
+}
+
+/* The top part of the navbar is highlighted in Egg Yolk */
+.wy-side-nav-search {
+  background-color: var(--egg-yolk);
+}
+
+/* Also on mobile */
+.wy-nav-top {
+  background: var(--egg-yolk);
+}
+.wy-nav-top a {
+  color: white;
+}
+.wy-nav-top a:visited {
+  color: white;
+}
+.wy-nav-top a:before {
+  content: "🦆";
+}
+
+/* Make link colors on top and bottom Egg Yolk to blend better in. */
+.wy-breadcrumbs a {
+  color: var(--egg-yolk);
+}
+.wy-breadcrumbs a:visited {
+  color: var(--egg-yolk);
+}
+footer a {
+  color: var(--egg-yolk);
+}
+footer a:visited {
+  color: var(--egg-yolk);
+}
+
+/* Make the entire sidebar cream, also the part we have expanded */
+.wy-menu-vertical li a {
+  background-color: var(--cream) !important;
+  /* Remove all borders around list elements in the navbar */
+  border-right: none !important;
+  border-bottom: none !important;
+  border-top: none !important;
+}
+
+/* Highlight list elements in sidebar on hover */
+.wy-menu-vertical li a:hover {
+  background-color: white !important;
+}
+
+/* Make the logo color aubergine */
+.wy-side-nav-search .icon a {
+  color: var(--grapefruit) !important;
+}
+.icon a:visited {
+  color: var(--grapefruit) !important;
+}
+
+/* Make the search field in the sidebar Cream colored */
+.wy-side-nav-search input[type="text"] {
+  background-color: var(--cream);
+  border-color: var(--cream);
+}
+
+/* Make class/function signatures consistently colored */
+.sig {
+  background: var(--cream) !important;
+  color: var(--aubergine) !important;
+  border-top: 3px solid var(--egg-yolk) !important;
+}
+
+/* Make all main headers Egg Yolk colored. */
+h1 {
+  color: var(--egg-yolk);
+}
+
+/* Make code example background color Cream. */
+.highlight {
+  background-color: var(--cream);
+}
+
+/* Make the icon color text white */
+.wy-side-nav-search a {
+  color: white !important;
+}
+.wy-side-nav-search a:visited {
+  color: white !important;
+}
+
+/* Decrease the vertical padding between menu items in the navbar */
+.wy-menu-vertical li.toctree-l3 a {
+  padding-top: 0.2vh !important;
+  padding-bottom: 0.2vh !important;
+}

patito-0.8.4/docs/api/index.rst

@@ -0,0 +1,10 @@
+API Reference
+=============
+
+.. toctree::
+   :caption: General Functionality
+   :maxdepth: 1
+
+   patito/DataFrame/index
+   patito/Model/index
+   patito/Field/index

patito-0.8.4/docs/api/patito/DataFrame/cast.rst

@@ -0,0 +1,6 @@
+patito.DataFrame.cast
+=====================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.cast

patito-0.8.4/docs/api/patito/DataFrame/derive.rst

@@ -0,0 +1,6 @@
+patito.DataFrame.derive
+=======================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.derive

patito-0.8.4/docs/api/patito/DataFrame/drop.rst

@@ -0,0 +1,6 @@
+patito.DataFrame.drop
+=====================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.drop

patito-0.8.4/docs/api/patito/DataFrame/fill_null.rst

@@ -0,0 +1,6 @@
+patito.DataFrame.fill_null
+==========================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.fill_null

patito-0.8.4/docs/api/patito/DataFrame/get.rst

@@ -0,0 +1,8 @@
+.. _DataFrame.get:
+
+patito.DataFrame.get
+====================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.get

patito-0.8.4/docs/api/patito/DataFrame/index.rst

@@ -0,0 +1,20 @@
+patito.DataFrame
+================
+
+.. currentmodule:: patito
+
+.. autoclass:: DataFrame
+
+.. toctree::
+   :caption: Methods
+   :maxdepth: 1
+
+   cast <cast>
+   derive <derive>
+   drop <drop>
+   fill_null <fill_null>
+   get <get>
+   iter_models <iter_models>
+   read_csv <read_csv>
+   set_model <set_model>
+   validate <validate>

patito-0.8.4/docs/api/patito/DataFrame/iter_models.rst

@@ -0,0 +1,8 @@
+.. _DataFrame.iter_models:
+
+patito.DataFrame.iter_models
+============================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.iter_models

patito-0.8.4/docs/api/patito/DataFrame/read_csv.rst

@@ -0,0 +1,6 @@
+patito.DataFrame.read_csv
+=========================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.read_csv

patito-0.8.4/docs/api/patito/DataFrame/set_model.rst

@@ -0,0 +1,8 @@
+.. _DataFrame.set_model:
+
+patito.DataFrame.set_model
+==========================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.set_model

patito-0.8.4/docs/api/patito/DataFrame/validate.rst

@@ -0,0 +1,8 @@
+.. _DataFrame.validate:
+
+patito.DataFrame.validate
+=========================
+
+.. currentmodule:: patito
+
+.. automethod:: DataFrame.validate

patito-0.8.4/docs/api/patito/Field/index.rst

@@ -0,0 +1,6 @@
+.. _Field:
+
+patito.Field
+============
+
+.. autofunction:: patito.Field

patito-0.8.4/docs/api/patito/Model/DataFrame.rst

@@ -0,0 +1,6 @@
+patito.Model.DataFrame
+======================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.DataFrame

patito-0.8.4/docs/api/patito/Model/LazyFrame.rst

@@ -0,0 +1,6 @@
+patito.Model.LazyFrame
+======================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.LazyFrame

patito-0.8.4/docs/api/patito/Model/columns.rst

@@ -0,0 +1,6 @@
+patito.Model.columns
+====================
+
+.. currentmodule:: patito._docs
+
+.. autoproperty:: Model.columns

patito-0.8.4/docs/api/patito/Model/defaults.rst

@@ -0,0 +1,6 @@
+patito.Model.defaults
+=====================
+
+.. currentmodule:: patito._docs
+
+.. autoproperty:: Model.defaults

patito-0.8.4/docs/api/patito/Model/drop.rst

@@ -0,0 +1,6 @@
+patito.Model.drop
+=================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.drop

patito-0.8.4/docs/api/patito/Model/dtypes.rst

@@ -0,0 +1,6 @@
+patito.Model.dtypes
+===================
+
+.. currentmodule:: patito._docs
+
+.. autoproperty:: Model.dtypes

patito-0.8.4/docs/api/patito/Model/example.rst

@@ -0,0 +1,6 @@
+patito.Model.example
+====================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.example

patito-0.8.4/docs/api/patito/Model/example_value.rst

@@ -0,0 +1,6 @@
+patito.Model.example_value
+==========================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.example_value

patito-0.8.4/docs/api/patito/Model/examples.rst

@@ -0,0 +1,8 @@
+.. _Model.examples:
+
+patito.Model.examples
+=====================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.examples

patito-0.8.4/docs/api/patito/Model/from_row.rst

@@ -0,0 +1,6 @@
+patito.Model.from_row
+=====================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.from_row

patito-0.8.4/docs/api/patito/Model/index.rst

@@ -0,0 +1,36 @@
+.. _Model:
+
+patito.Model
+============
+
+.. currentmodule:: patito
+
+.. autoclass:: Model
+
+.. toctree::
+   :caption: Class methods & properties
+   :maxdepth: 1
+
+   DataFrame <DataFrame>
+   LazyFrame <LazyFrame>
+   columns <columns>
+   defaults <defaults>
+   drop <drop>
+   dtypes <dtypes>
+   example <example>
+   example_value <example_value>
+   examples <examples>
+   from_row <from_row>
+   iter_models <iter_models>
+   join <join>
+   non_nullable_columns <non_nullable_columns>
+   nullable_columns <nullable_columns>
+   pandas_examples <pandas_examples>
+   prefix <prefix>
+   rename <rename>
+   select <select>
+   suffix <suffix>
+   unique_columns <unique_columns>
+   valid_dtypes <valid_dtypes>
+   validate <validate>
+   with_fields <with_fields>

patito-0.8.4/docs/api/patito/Model/iter_models.rst

@@ -0,0 +1,8 @@
+.. _Model.iter_models:
+
+patito.Model.iter_models
+========================
+
+.. currentmodule:: patito
+
+.. automethod:: Model.iter_models