ogre-sdk 0.1.0__tar.gz

ogre_sdk-0.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+  "name": "Python SDK (3.13, uv)",
+
+  "dockerComposeFile": "../docker-compose.yml",
+  "service": "dev",
+
+  "workspaceFolder": "/workspace",
+
+  "remoteUser": "appuser",
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
+    }
+  },
+  "features": {
+    "ghcr.io/anthropics/devcontainer-features/claude-code:1.0": {}
+  }
+}

ogre_sdk-0.1.0/.dockerignore

@@ -0,0 +1,7 @@
+.venv
+__pycache__
+.git
+.devcontainer
+dist
+build
+*.pyc

ogre_sdk-0.1.0/.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          python-version: "3.13"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ogre_sdk-0.1.0/.github/workflows/on-pull-request.yml

@@ -0,0 +1,30 @@
+name: test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      # - name: Run tests
+      #   run: uv run pytest
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: ogre-sdk-dist
+          path: dist/

ogre_sdk-0.1.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,24 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [dev, prod, master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files

ogre_sdk-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Claude Code
+.claude/
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

ogre_sdk-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+  - repo: 'https://github.com/pre-commit/pre-commit-hooks'
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: forbid-submodules
+      - id: mixed-line-ending
+      - id: name-tests-test
+        args: [--pytest-test-first]
+
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        entry: ruff check
+        language: system
+        types: [python]
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+        name: ruff-format
+        entry: ruff format
+        language: system
+        types: [python]
+      - id: mypy
+        name: mypy
+        entry: mypy ogre_sdk
+        language: system
+        pass_filenames: false

ogre_sdk-0.1.0/CLAUDE.md

@@ -0,0 +1,7 @@
+# CLAUDE.md
+
+## Memory
+
+This project runs in a Docker container. The container home directory (`/home/appuser/`) is ephemeral and lost on rebuild.
+
+**Always store memory in `/workspace/.claude/memory/`** — this directory is inside the volume mount and persists across rebuilds. Never use the default `/home/appuser/.claude/projects/` path for memory.

ogre_sdk-0.1.0/Dockerfile

@@ -0,0 +1,45 @@
+# ---------- base (shared by dev & CI) ----------
+FROM python:3.13-slim
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && apt-get install -y \
+    bash \
+    curl \
+    git \
+    build-essential \
+    nodejs \
+    npm \
+    && rm -rf /var/lib/apt/lists/*
+
+# Use bash for later RUN commands so devcontainer feature scripts that rely on bash work correctly
+SHELL ["/bin/bash", "-lc"]
+
+# install uv to a system-wide path so it's accessible to all users
+RUN curl -Ls https://astral.sh/uv/install.sh | UV_INSTALL_DIR=/usr/local/bin sh
+
+# create non-root user
+ARG USERNAME=appuser
+ARG USER_UID=1000
+ARG USER_GID=1000
+
+RUN groupadd --gid $USER_GID $USERNAME \
+    && useradd --shell /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME
+
+WORKDIR /workspace
+
+# dependency layer
+COPY pyproject.toml uv.lock* ./
+
+ENV UV_PROJECT_ENVIRONMENT=/workspace/.venv
+
+RUN uv sync --frozen
+
+RUN chown -R $USERNAME:$USERNAME /workspace
+
+ENV PATH="/workspace/.venv/bin:$PATH"
+ENV CLAUDE_CONFIG_DIR=/workspace/.claude
+
+USER $USERNAME
+
+CMD ["bash"]

ogre_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: ogre-sdk
+Version: 0.1.0
+Summary: Python SDK for the ogre.ai API
+Requires-Python: >=3.13
+Requires-Dist: pydantic>=2.0
+Requires-Dist: requests>=2.32
+Provides-Extra: dev
+Requires-Dist: jupyterlab>=4.0; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'

ogre_sdk-0.1.0/README.md

@@ -0,0 +1,21 @@
+# ogre-sdk
+
+Python SDK for the [ogre.ai](https://ogre.ai) API.
+
+## Development
+
+### Standard environment
+
+```bash
+docker compose up
+```
+
+Starts the container with `sleep infinity` — attach to it for a shell or use it with your IDE.
+
+### Jupyter environment
+
+```bash
+docker compose -f docker-compose.yml -f docker-compose.dev.yml up
+```
+
+Installs dev dependencies (`jupyterlab`, `pytest`, `ruff`, `mypy`) and starts Jupyter Lab at [http://localhost:8888](http://localhost:8888).

ogre_sdk-0.1.0/demo.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+"""End-to-end demand forecast pipeline using the ogre-sdk."""
+
+import logging
+from datetime import UTC, datetime
+from pathlib import Path
+
+from ogre_sdk import Ogre
+
+API_KEY = ""  # your Ogre API key
+PROJECT_ID = "737f49b8-8b15-423c-adad-b1a8249a66d0"
+DSO_ID = "7cefd274-f822-498c-ad7d-ccedb259d95b"
+PROFILE_ID = "2c3c831f-8ade-497e-9c30-98e37aa26260"
+
+CSV_PATH = Path("historical.csv")
+
+TRAIN_START = datetime(2016, 1, 1, tzinfo=UTC)
+TRAIN_END = datetime(2017, 12, 31, tzinfo=UTC)
+FORECAST_START = datetime(2018, 1, 1, tzinfo=UTC)
+FORECAST_END = datetime(2018, 2, 1, tzinfo=UTC)
+
+logging.basicConfig(level=logging.INFO, format="%(asctime)s | %(levelname)s | %(message)s")
+log = logging.getLogger(__name__)
+
+client = Ogre(api_key=API_KEY, project_id=PROJECT_ID)
+
+sources = client.meteo_sources.list()
+log.info("%d meteo source(s) available", len(sources))
+
+consumer = client.consumers.create(
+    name="Demo Consumer",
+    latitude=53.350,
+    longitude=-6.260,
+    dso_id=DSO_ID,
+    profile_id=PROFILE_ID,
+    external_id="external-consumer-id",
+)
+log.info("Consumer id:          %s", consumer.id)
+log.info("Meteo location id:    %s", consumer.meteo_location.id)
+log.info("Forecast settings id: %s", consumer.forecast_settings.id)
+
+consumer.import_historical(CSV_PATH, start_date=TRAIN_START, end_date=TRAIN_END).wait()
+
+consumer.ingest_meteo(TRAIN_START, TRAIN_END).wait()
+
+trained_model = consumer.train(TRAIN_START, TRAIN_END).wait()
+log.info("Trained model id: %s", trained_model["id"])
+
+if FORECAST_END > TRAIN_END:
+    consumer.ingest_meteo(FORECAST_START, FORECAST_END).wait()
+
+result = consumer.run_forecast(FORECAST_START, FORECAST_END).wait()
+log.info("Forecast records: %d", len(result))

ogre_sdk-0.1.0/docker-compose.dev.yml

@@ -0,0 +1,14 @@
+version: "3.9"
+
+services:
+  dev:
+    build:
+      args:
+        INSTALL_DEV: "true"
+
+    ports:
+      - "8888:8888"
+
+    command: >
+      bash -c "uv sync --frozen --extra dev &&
+               jupyter lab --ip=0.0.0.0 --port=8888 --no-browser"

ogre_sdk-0.1.0/docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3.9"
+
+services:
+  dev:
+    build:
+      context: .
+      dockerfile: Dockerfile
+
+    volumes:
+      - .:/workspace
+
+    working_dir: /workspace
+
+    environment:
+      - CLAUDE_CONFIG_DIR=/workspace/.claude
+
+    command: sleep infinity