replenishment 0.1.0__tar.gz

replenishment-0.1.0/.github/ISSUE_TEMPLATE/release_checklist.yml

@@ -0,0 +1,52 @@
+name: Release checklist
+description: Track tasks for publishing a new version to GitHub Releases and PyPI.
+title: "Release vX.Y.Z"
+labels:
+  - release
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this checklist for each production release.
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Semantic version without `v` prefix (example `0.2.0`).
+      placeholder: 0.2.0
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: preflight
+    attributes:
+      label: Pre-flight
+      options:
+        - label: CI is green on main.
+        - label: Release notes are prepared.
+        - label: PyPI trusted publisher is configured for this repo.
+
+  - type: checkboxes
+    id: tag_release
+    attributes:
+      label: Tag and GitHub release
+      options:
+        - label: I created and pushed the tag `vX.Y.Z` from main.
+        - label: I published a GitHub Release for `vX.Y.Z`.
+        - label: Release workflow completed successfully.
+
+  - type: checkboxes
+    id: post_release
+    attributes:
+      label: Post-release verification
+      options:
+        - label: Dist artifacts are attached to the GitHub Release.
+        - label: Package `replenishment==X.Y.Z` is visible on PyPI.
+        - label: I installed from PyPI in a clean environment and smoke-tested import.
+
+  - type: textarea
+    id: notes
+    attributes:
+      label: Notes
+      description: Optional links or follow-ups.

replenishment-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package and test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest

replenishment-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,74 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      git_ref:
+        description: "Tag or commit to publish (example: v0.2.0)"
+        required: true
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.inputs.git_ref || github.ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build distribution artifacts
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+          python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  github-release-assets:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Upload artifacts to GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+
+  pypi-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/replenishment
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

replenishment-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#  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/
+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
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# setuptools-scm generated version file
+src/replenishment/_version.py

replenishment-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

replenishment-0.1.0/PKG-INFO

@@ -0,0 +1,259 @@
+Metadata-Version: 2.4
+Name: replenishment
+Version: 0.1.0
+Summary: Stock replenishment simulation library.
+Project-URL: Homepage, https://github.com/janrth/replenishment
+Project-URL: Repository, https://github.com/janrth/replenishment
+Project-URL: Issues, https://github.com/janrth/replenishment/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ipykernel>=6.31.0
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: pandas>=2.0
+Requires-Dist: polars>=1.36.1
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: scienceplots>=2.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+
+# replenishment
+
+Stock replenishment simulation utilities.
+
+## Environment (uv + Python 3.12)
+
+This repo is set up to use Python 3.12 via `uv`.
+
+```bash
+uv python install 3.12
+uv venv --python 3.12
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+```
+
+Run checks with:
+
+```bash
+uv run pytest
+```
+
+## Release and PyPI publishing
+
+This repository is configured so that publishing on PyPI is done from GitHub
+Actions (`.github/workflows/release.yml`), not from local `twine upload`.
+
+### One-time setup
+
+1. Create a PyPI project named `replenishment` (or let the first publish create it).
+2. In PyPI, configure a trusted publisher for this repository and workflow:
+   - Owner: `janrth`
+   - Repository: `replenishment`
+   - Workflow: `release.yml`
+   - Environment: `pypi`
+3. In GitHub, create an environment named `pypi` in repo settings.
+
+### Versioning
+
+Package versions are derived from git tags via `setuptools-scm`. Use semantic
+tags such as `v0.1.0`, `v0.2.0`, etc.
+
+### Release flow (GitHub-first)
+
+1. Push a version tag:
+
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+
+2. In GitHub, create/publish a release for that tag.
+3. The `Release` workflow will:
+   - build `sdist` and wheel artifacts,
+   - attach them to the GitHub release,
+   - publish them to PyPI automatically.
+
+You can also run the workflow manually from the Actions tab using `workflow_dispatch`
+and pass `git_ref` (for example `v0.1.0`).
+
+## Usage
+## Plot-first usage
+
+This README focuses on two visual workflows:
+
+- Mean forecast + safety stock optimization.
+- Percentile target optimization.
+
+## Example 1: mean forecast + safety stock
+
+This example optimizes the safety stock factor on a backtest window, then
+applies the learned policy to the evaluation horizon.
+
+```python
+from replenishment import (
+    generate_standard_simulation_rows,
+    optimize_point_forecast_policy_and_simulate_actuals,
+    plot_replenishment_decisions,
+    replenishment_decision_rows_to_dataframe,
+    split_standard_simulation_rows,
+    standard_simulation_rows_to_dataframe,
+)
+
+rows = generate_standard_simulation_rows(
+    n_unique_ids=1,
+    periods=18,
+    start_date="2031-01-01",
+    frequency_days=30,
+    forecast_start_period=10,
+    history_mean=52,
+    history_std=6,
+    forecast_mean=48,
+    forecast_std=5,
+    lead_time=2,
+    initial_on_hand=30,
+    current_stock=30,
+    seed=7,
+)
+backtest_rows, eval_rows = split_standard_simulation_rows(rows)
+
+optimized, _, decision_rows = optimize_point_forecast_policy_and_simulate_actuals(
+    backtest_rows,
+    eval_rows,
+    candidate_factors=[0.8, 0.9, 1.0],
+)
+
+rows_df = standard_simulation_rows_to_dataframe(rows, library="pandas")
+decision_df = replenishment_decision_rows_to_dataframe(decision_rows, library="pandas")
+
+example_id = decision_df["unique_id"].iloc[0]
+plot_replenishment_decisions(
+    rows_df,
+    decision_df,
+    unique_id=example_id,
+    title="Mean forecast + safety stock (optimized)",
+    decision_style="line",
+)
+```
+
+![Mean forecast + safety stock example](docs/plots/mean_forecast_safety_stock.png)
+
+## Example 2: optimize percentile targets
+
+This example learns the best percentile target on backtest rows and then plots
+replenishment decisions on forecast rows.
+
+```python
+from replenishment import (
+    PercentileForecastOptimizationPolicy,
+    build_percentile_forecast_candidates_from_standard_rows,
+    build_replenishment_decisions_from_simulations,
+    generate_standard_simulation_rows,
+    optimize_forecast_targets,
+    plot_replenishment_decisions,
+    replenishment_decision_rows_to_dataframe,
+    simulate_replenishment_with_aggregation,
+    split_standard_simulation_rows,
+    standard_simulation_rows_to_dataframe,
+)
+
+rows = generate_standard_simulation_rows(
+    n_unique_ids=1,
+    periods=24,
+    start_date="2031-01-01",
+    frequency_days=30,
+    forecast_start_period=14,
+    history_mean=42,
+    history_std=7,
+    forecast_mean=40,
+    forecast_std=5,
+    lead_time=2,
+    initial_on_hand=25,
+    current_stock=25,
+    seed=11,
+    percentile_multipliers={"p50": 1.0, "p80": 1.2, "p95": 1.35},
+)
+backtest_rows, forecast_rows = split_standard_simulation_rows(rows)
+
+percentile_configs = build_percentile_forecast_candidates_from_standard_rows(
+    backtest_rows,
+    include_mean=True,
+    review_period=1,
+    forecast_horizon=1,
+)
+optimized = optimize_forecast_targets(percentile_configs)
+
+forecast_configs = build_percentile_forecast_candidates_from_standard_rows(
+    forecast_rows,
+    include_mean=True,
+    review_period=1,
+    forecast_horizon=1,
+)
+simulations = {}
+for unique_id, config in forecast_configs.items():
+    target = optimized[unique_id].target
+    policy = PercentileForecastOptimizationPolicy(
+        forecast=config.forecast_candidates[target],
+        lead_time=config.lead_time,
+    )
+    simulations[unique_id] = simulate_replenishment_with_aggregation(
+        periods=config.periods,
+        demand=config.demand,
+        initial_on_hand=config.initial_on_hand,
+        lead_time=config.lead_time,
+        policy=policy,
+        aggregation_window=1,
+        holding_cost_per_unit=config.holding_cost_per_unit,
+        stockout_cost_per_unit=config.stockout_cost_per_unit,
+        order_cost_per_order=config.order_cost_per_order,
+        order_cost_per_unit=config.order_cost_per_unit,
+    )
+
+decision_rows = build_replenishment_decisions_from_simulations(
+    forecast_rows,
+    simulations,
+    percentile_target={uid: optimized[uid].target for uid in simulations},
+    review_period=1,
+    forecast_horizon=1,
+    rmse_window=1,
+)
+rows_df = standard_simulation_rows_to_dataframe(rows, library="pandas")
+decision_df = replenishment_decision_rows_to_dataframe(decision_rows, library="pandas")
+
+example_id = decision_df["unique_id"].iloc[0]
+plot_replenishment_decisions(
+    rows_df,
+    decision_df,
+    unique_id=example_id,
+    title="Percentile forecast target (optimized)",
+    decision_style="line",
+)
+```
+
+![Percentile target optimization example](docs/plots/percentile_optimization.png)
+
+## Notebooks
+
+For full runnable walkthroughs (including additional variants):
+
+- `notebooks/mean_forecast_safety_stock_example.ipynb`
+- `notebooks/percentile_optimization_example.ipynb`
+- `notebooks/generated_data_example.ipynb`
+
+For data-loading and table-oriented flows (without plots), see:
+
+- `notebooks/stock_replenishment_example.ipynb`
+
+## Standard schema helpers
+
+If you need CSV/DataFrame conversion helpers:
+
+- `iter_standard_simulation_rows_from_csv`
+- `standard_simulation_rows_from_dataframe`
+- `build_point_forecast_article_configs_from_standard_rows`