EPA-PM-API-Wrapper 0.3.0__tar.gz

epa_pm_api_wrapper-0.3.0/.editorconfig

@@ -0,0 +1,37 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{html,css,js,json,sh,yml,yaml}]
+indent_size = 2
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[justfile]
+indent_style = space
+indent_size = 4
+
+# Ignore binary or generated files
+[*.{png,jpg,gif,ico,woff,woff2,ttf,eot,svg,pdf}]
+charset = unset
+end_of_line = unset
+indent_style = unset
+indent_size = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset
+max_line_length = unset
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

epa_pm_api_wrapper-0.3.0/.env.example

@@ -0,0 +1,5 @@
+# EPA Portfolio Manager Credentials
+EPA_PM_USERNAME=your_username
+EPA_PM_PASSWORD=your_password
+# Set to 'true' to use the test environment
+EPA_PM_TEST=false

epa_pm_api_wrapper-0.3.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug Report
+description: Something isn't working as expected.
+title: "BUG: "
+labels: [bug]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: What happened? What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps to trigger the bug.
+      placeholder: |
+        1. Install with `uv pip install EPA-PM-API-Wrapper`
+        2. Run `...`
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: "EPA PM API Wrapper version"
+      placeholder: "0.1.0"
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      placeholder: "3.13"
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - macOS
+        - Linux
+        - Windows
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Logs, tracebacks, screenshots, or anything else that helps.
+    validations:
+      required: false

epa_pm_api_wrapper-0.3.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

epa_pm_api_wrapper-0.3.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,30 @@
+name: Feature Request
+description: Suggest something new.
+title: "FEAT: "
+labels: [enhancement]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: What problem does this solve? What's the use case?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+    validations:
+      required: false

epa_pm_api_wrapper-0.3.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    open-pull-requests-limit: 5

epa_pm_api_wrapper-0.3.0/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## What
+
+<!-- 1-3 sentences. Link the issue if there is one. -->
+
+## AI Provenance
+
+<!-- Remove this section for human-authored PRs. -->
+
+- **Tool:** <!-- Claude Code, Cursor, Copilot, Codex, etc. -->
+- **Model:** <!-- Claude Opus 4.6, GPT-4o, etc. -->
+- **Prompt/thread:** <!-- Paste your prompt or a link to the thread. -->
+
+## Checklist
+
+- [ ] Addresses exactly one issue or feature
+- [ ] New or changed behavior has test coverage
+- [ ] Diff contains only changes for this task

epa_pm_api_wrapper-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,112 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+  type-check:
+    name: Type check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+
+      - name: Type check with ty
+        run: uv run ty check .
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+
+      - name: Run tests with coverage
+        run: uv run --python=${{ matrix.python-version }} coverage run -m pytest
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: coverage-${{ matrix.python-version }}
+          path: .coverage.*
+          include-hidden-files: true
+
+  coverage:
+    name: Coverage
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+
+      - name: Download coverage data
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      - name: Combine coverage
+        run: uv run coverage combine
+
+      - name: Coverage report
+        run: |
+          echo '## Coverage Report' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          uv run coverage report | tee -a $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+
+  all-checks-pass:
+    name: All checks pass
+    if: always()
+    needs: [lint, type-check, test, coverage]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check job results
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+        with:
+          jobs: ${{ toJSON(needs) }}

epa_pm_api_wrapper-0.3.0/.github/workflows/codeql.yml

@@ -0,0 +1,36 @@
+name: CodeQL
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: '0 6 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+        with:
+          languages: python  # Add c-cpp, go, java-kotlin, or swift if needed
+          build-mode: none   # Switch to autobuild for compiled languages
+          queries: security-extended
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4

epa_pm_api_wrapper-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: docs-deploy
+  # Let in-flight deployments finish to avoid a half-deployed site.
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+
+      - name: Build docs
+        run: uv run --group docs zensical build --clean
+
+      - uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+
+      - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
+        with:
+          path: site
+
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
+        id: deployment

epa_pm_api_wrapper-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,63 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      # Cache disabled to prevent cache-poisoning attacks on release artifacts.
+      - uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
+        with:
+          enable-cache: false
+
+      - name: Build
+        run: uv build
+
+      - name: Upload distribution
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      attestations: write
+    # Requires environment protection rules in GitHub Settings:
+    # Settings > Environments > pypi > Add required reviewers
+    # and restrict deployment to v* tags.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/EPA-PM-API-Wrapper
+    steps:
+      - name: Download distribution
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Attest build provenance
+        uses: actions/attest-build-provenance@a2bbfa25375fe432b6a289bc6b6cd05ecd0c4c32 # v4.1.0
+        with:
+          subject-path: "dist/*"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0

epa_pm_api_wrapper-0.3.0/.github/workflows/zizmor.yml

@@ -0,0 +1,37 @@
+name: Workflow security analysis
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/**"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+    paths:
+      - ".github/workflows/**"
+
+permissions:
+  contents: read
+
+jobs:
+  zizmor:
+    name: Run zizmor
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: Run zizmor
+        uses: zizmorcore/zizmor-action@71321a20a9ded102f6e9ce5718a2fcec2c4f70d8 # v0.5.2
+        with:
+          inputs: ./.github/

epa_pm_api_wrapper-0.3.0/.gitignore

@@ -0,0 +1,54 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+build/
+dist/
+eggs/
+.eggs/
+*.egg-info/
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+coverage.xml
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.envrc
+.venv
+
+# uv
+#   Generally recommended to include uv.lock in version control for
+#   reproducibility. Uncomment for libraries where you want consumers
+#   to resolve their own dependencies.
+# uv.lock
+
+# Ruff
+.ruff_cache/
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# Documentation build output
+site/
+
+# IDE files
+# .idea/
+# .vscode/

epa_pm_api_wrapper-0.3.0/CHANGELOG/0.1.0.md

@@ -0,0 +1,27 @@
+## EPA PM API Wrapper 0.1.0
+
+Client wrapper for the EPA Portfolio Manager API.
+
+This release reserves the PyPI package name and establishes the project scaffold.
+
+```sh
+uv add EPA-PM-API-Wrapper
+```
+
+### What's in the scaffold
+
+- `src/epa_pm_api_wrapper/` package with CLI (Typer + Rich), py.typed marker
+- Tests with pytest, coverage across Python 3.12/3.13/3.14
+- CI via GitHub Actions: lint (Ruff), type check (ty), test matrix, coverage reporting
+- Security scanning: CodeQL analysis, Dependabot, zizmor workflow audit
+- Docs site with Zensical + mkdocstrings, auto-deployed to GitHub Pages
+- Trusted publishing to PyPI with OIDC and build provenance attestation
+- `justfile` with dev commands: qa, test, type-check, docs-serve, release
+- Issue templates, PR template, contributing guide, code of conduct, security policy
+- MIT license, .editorconfig, .gitignore
+
+Built with [Cookiecutter PyPackage](https://github.com/audreyfeldroy/cookiecutter-pypackage).
+
+### Contributors
+
+[@harryw1](https://github.com/harryw1) (Harrison Weiss) created EPA PM API Wrapper.

epa_pm_api_wrapper-0.3.0/CHANGELOG/0.2.0.md

@@ -0,0 +1,62 @@
+## EPA PM API Wrapper 0.2.0
+
+This release brings the wrapper to near-complete coverage of the EPA Portfolio
+Manager web services API. Every public API category — Account, Connection,
+Property, PropertyUse, Building, Meter, Reporting, Target Finder, and Home
+Energy Yardstick — now has at least one resource bound on `EpaPmClient`.
+
+```sh
+uv add EPA-PM-API-Wrapper
+```
+
+### New top-level resources
+
+- `client.association` — property↔meter and propertyUse↔meter associations
+  (list, set-many, add-one, remove-one)
+- `client.target_finder.evaluate(design, measurement_system="EPA")` —
+  estimate annual metrics for a candidate property design
+- `client.hey.evaluate(design)` — Home Energy Yardstick scoring (test
+  environment only)
+
+### New sub-namespaces
+
+- `client.meter.identifier` — full mirror of the property identifier resource
+  (CRUD + types catalog + property-scoped list)
+- `client.property.design` — property design characteristics (GET / PUT)
+- `client.property.energy_performance_project` — EPP CRUD
+- `client.property.billboard` — billboard metric catalog and per-property /
+  per-customer settings
+- `client.property.edu` / `.pgp` / `.weather_station` / `.e_grid_subregion`
+  / `.federal_agency` — list and assignment endpoints
+- `client.property_use.use_details` — use-detail revision history (add, list,
+  get, update)
+- `client.property_use.custom_use` — property-level user-defined use details
+
+### Filled CRUD gaps on existing resources
+
+- `client.property_use.create`
+- `client.building.delete`
+- `client.customer.create`
+- `client.consumption_data.update` / `.delete` / `.delete_range`
+- `client.hierarchy.use_details` / `.waste_data`
+
+### `whatChanged` endpoints
+
+A `what_changed(customer_id, date)` (or property-scoped equivalent) is now
+available on `property`, `property_use`, `meter`, `consumption_data`,
+`waste_data`, and `property_use.use_details`. `meter.what_changed` accepts
+either `customer_id` *or* `property_id` and validates that exactly one is
+passed.
+
+### Tests
+
+47 new tests across new files (`test_association.py`,
+`test_consumption_data.py`, `test_meter_identifier.py`,
+`test_property_subresources.py`, `test_property_use_subresources.py`,
+`test_target_finder_and_hey.py`, `test_building_and_hierarchy_extras.py`)
+plus extensions to `test_meter_aggregate.py` and `test_waste_data.py`.
+Suite is at 129 passing.
+
+### Contributors
+
+[@harryw1](https://github.com/harryw1) (Harrison Weiss)