aggdisagg 1.0.3__tar.gz

aggdisagg-1.0.3/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras
+
+      - name: Lint with ruff
+        run: uv run ruff check .
+
+      - name: Type check with pyright
+        run: uv run pyright src
+
+      - name: Test with pytest
+        run: uv run pytest --cov=aggdisagg --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v3
+        if: matrix.python-version == '3.12'

aggdisagg-1.0.3/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Build
+        run: uv build
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/p/aggdisagg
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # For TestPyPI first (optional): use a separate job or environment "testpypi" + --repository testpypi
+

aggdisagg-1.0.3/.gitignore

@@ -0,0 +1,163 @@
+# 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/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Ruff
+.ruff_cache/
+
+# Pyright
+pyrightconfig.json
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# uv
+uv.lock

aggdisagg-1.0.3/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+conduct@aggdisagg.dev.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

aggdisagg-1.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aggdisagg contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aggdisagg-1.0.3/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: aggdisagg
+Version: 1.0.3
+Summary: Temporal Aggregation & Disaggregation for Modern Python (Polars-first)
+Project-URL: Homepage, https://github.com/aggdisagg/aggdisagg
+Project-URL: Repository, https://github.com/aggdisagg/aggdisagg
+Project-URL: Issues, https://github.com/aggdisagg/aggdisagg/issues
+Project-URL: Documentation, https://aggdisagg.readthedocs.io
+Author: aggdisagg Contributors
+License: MIT
+License-File: LICENSE
+Keywords: econometrics,frequency-conversion,pandas,polars,temporal-aggregation,temporal-disaggregation,time-series
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: polars>=1.0.0
+Requires-Dist: scipy>=1.10.0
+Provides-Extra: all
+Requires-Dist: pandas>=2.0.0; extra == 'all'
+Requires-Dist: plotly>=5.0.0; extra == 'all'
+Requires-Dist: scikit-learn>=1.3.0; extra == 'all'
+Requires-Dist: sktime>=0.25.0; extra == 'all'
+Requires-Dist: statsforecast>=1.5.0; extra == 'all'
+Requires-Dist: xarray>=2023.0.0; extra == 'all'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0.0; extra == 'pandas'
+Provides-Extra: plot
+Requires-Dist: plotly>=5.0.0; extra == 'plot'
+Provides-Extra: sklearn
+Requires-Dist: scikit-learn>=1.3.0; extra == 'sklearn'
+Provides-Extra: sktime
+Requires-Dist: sktime>=0.25.0; extra == 'sktime'
+Provides-Extra: statsforecast
+Requires-Dist: statsforecast>=1.5.0; extra == 'statsforecast'
+Provides-Extra: xarray
+Requires-Dist: xarray>=2023.0.0; extra == 'xarray'
+Description-Content-Type: text/markdown
+
+# aggdisagg
+
+> **Temporal Aggregation & Disaggregation for Modern Python**
+
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org)
+[![Polars](https://img.shields.io/badge/Polars-first-orange)](https://pola.rs)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![PyPI](https://img.shields.io/pypi/v/aggdisagg)](https://pypi.org/project/aggdisagg/)
+[![GitHub](https://img.shields.io/badge/GitHub-aggdisagg-black?logo=github)](https://github.com/aggdisagg/aggdisagg)
+
+<!-- GitHub social preview: the image below is auto-generated for social sharing -->
+![aggdisagg social preview](https://opengraph.githubassets.com/1/aggdisagg/aggdisagg)
+
+**Install & try in 10 seconds:**
+
+```bash
+pip install aggdisagg
+```
+
+```python
+import polars as pl
+from aggdisagg import TemporalAligner
+df = pl.DataFrame({"date": ["2020", "2021"], "y": [100.0, 120.0]})
+print(TemporalAligner().fit_transform(df, datetime_col="date", target_col="y"))
+```
+
+**aggdisagg** is a clean, **Polars-first** Python library for converting time series between frequencies with **perfect aggregation consistency**.
+
+- Disaggregate low → high frequency (with indicators)
+- Aggregate high → low frequency (symmetric)
+- Works with **Polars** (primary), **pandas**, and **xarray**
+
+## Installation + Try in 10 Seconds
+
+```bash
+pip install "aggdisagg[all]" && python -c "
+import polars as pl
+from datetime import date
+from aggdisagg import TemporalAligner
+df = pl.DataFrame({'date':[date(2020,1,1),date(2021,1,1)], 'y':[1000.,1200.]})
+print(TemporalAligner(method='uniform').fit_transform(df, datetime_col='date', target_col='y'))
+"
+```
+
+## Quickstart with `TemporalAligner`
+
+```python
+import polars as pl
+from datetime import date
+from aggdisagg import TemporalAligner
+
+df = pl.DataFrame({
+    "date": [date(2020, 1, 1), date(2021, 1, 1), date(2022, 1, 1)],
+    "y": [1200.0, 1500.0, 1350.0],      # low-frequency target
+    "indicator": [100.0, 125.0, 110.0], # high-frequency indicator
+})
+
+aligner = TemporalAligner(
+    method="chow-lin-opt",
+    target_freq="1mo",
+    agg="sum",
+    indicator_cols=["indicator"],
+)
+
+monthly = aligner.fit_transform(df, datetime_col="date", target_col="y")
+print(monthly.head())
+
+# Perfect symmetric aggregation
+yearly_back = aligner.aggregate(monthly, freq="1y")
+print("Roundtrip OK:", (yearly_back["y_1y"] - df["y"]).abs().sum() < 1e-8)
+
+# Plot (requires plotly)
+monthly.plot()  # or use .plot() on the result if extended
+```
+
+## Supported Methods
+
+- `uniform`
+- `linear`
+- `denton` / `denton-cholette`
+- `chow-lin`, `chow-lin-opt` (auto ρ via maxlog/minrss)
+- `litterman`, `fernandez`
+
+All methods guarantee `C @ y_high ≈ y_low` exactly.
+
+## Why aggdisagg?
+
+- **Polars-native** core (lazy-friendly)
+- **Perfect consistency** by construction (C/D matrices)
+- **Sklearn-style** + fluent API
+- Real econometric methods (Denton quadratic, Chow-Lin GLS)
+- Excellent pandas / xarray interop
+- Production quality (typed, tested, documented)
+
+## v0.2 Highlights
+
+- Hierarchical reconciliation (national → regional)
+- Uncertainty (bootstrap + analytic std errors)
+- Full Polars lazy + xarray DataArray I/O
+- Negative post-correction + NNLS ensemble
+- sktime / statsforecast compatible wrapper
+
+```python
+# Hierarchical
+rec = aligner.reconcile_hierarchical([nat_df, reg_df])
+
+# Uncertainty
+mean, std = aligner.predict_with_uncertainty()
+
+# Lazy + xarray
+lazy_high = aligner.fit_transform(lazy_df)
+xa = aligner.to_xarray(high_df)
+```
+
+See `examples/quickstart.py` for complete gallery.
+
+## Development & Publishing
+
+```bash
+uv sync --all-extras
+uv run pytest
+uv run python examples/quickstart.py
+uv build
+# twine or uv publish
+```
+
+## License
+
+MIT
+
+---
+
+**Built for data scientists who want temporal frequency conversion that just works.**