refresh-engine 0.1.0__tar.gz

refresh_engine-0.1.0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5

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

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Python 3.12 / ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - run: uv sync --frozen
+      - run: uv run ruff check .
+      - run: uv run black --check .
+      - run: uv run pyrefly check
+      - run: uv run pytest --cov=refresh_engine --cov-report=term-missing
+      - run: uv run python scripts/check_docs_examples.py
+      - run: uv run python scripts/run_examples.py
+      - run: uv run mkdocs build --strict
+
+  distribution:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - run: uv sync --frozen
+      - run: uv build
+      - run: uv publish --dry-run --trusted-publishing never dist/*
+      - run: uv run python scripts/validate_distribution.py dist

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

@@ -0,0 +1,61 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - name: Synchronize environment
+        run: uv sync --frozen
+      - name: Verify release version
+        if: startsWith(github.ref, 'refs/tags/')
+        shell: pwsh
+        run: |
+          $tag = $env:GITHUB_REF_NAME.TrimStart("v")
+          $project = uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])"
+          $package = uv run python -c "import refresh_engine; print(refresh_engine.__version__)"
+          if ($tag -ne $project -or $tag -ne $package) {
+            throw "Tag ($tag), project ($project), and package ($package) versions differ"
+          }
+      - run: uv run ruff check .
+      - run: uv run black --check .
+      - run: uv run pyrefly check
+      - run: uv run pytest --cov
+      - run: uv run mkdocs build --strict
+      - run: uv build
+      - run: uv publish --dry-run --trusted-publishing never dist/*
+      - run: uv run python scripts/validate_distribution.py dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-distributions
+          path: dist/
+      - uses: astral-sh/setup-uv@v6
+      - name: Publish with trusted identity
+        run: uv publish --trusted-publishing always dist/*

refresh_engine-0.1.0/.github/workflows/security.yml

@@ -0,0 +1,26 @@
+name: Security
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: "23 5 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - run: uv sync --frozen
+      - run: uv export --frozen --no-dev --no-emit-project -o runtime-requirements.txt
+      - run: uv run pip-audit --requirement runtime-requirements.txt

refresh_engine-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyd
+*.so
+.python-version
+
+# Environments and tools
+.venv/
+venv/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+.hypothesis/
+.mypy_cache/
+.pyrefly/
+
+# Builds and documentation
+build/
+dist/
+site/
+*.egg-info/
+
+# Local state
+*.db
+*.db-shm
+*.db-wal
+*.sqlite
+*.sqlite3
+benchmark-results.json
+
+# Editors and operating systems
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db

refresh_engine-0.1.0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - method: uv
+      command: sync
+      groups:
+        - docs

refresh_engine-0.1.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes are documented here using
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) conventions. This project
+uses semantic versioning.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-09-24
+
+### Added
+
+- User, contributor, security, architecture, API, and task-oriented guide
+  documentation.
+- Domain-neutral examples for supported integration scenarios.
+- Reproducible benchmark harness for 1k, 10k, and 100k resource workloads and
+  multiple change profiles.
+- Application-owned SQLite and PostgreSQL store examples demonstrating atomic commits,
+  restart continuity, rollback, and public `StateStoreABC` injection.
+- Trusted Publishing release workflow.
+- Optional abstract base classes for sources, fingerprints, operations, selectors,
+  state stores/transactions, events, metrics, and async schedulers.
+- Native required `structlog` integration for structured lifecycle logging.
+- NetworkX-backed dependency graph algorithms, Tenacity-backed retry policies, and
+  APScheduler-backed interval scheduling.
+- Async-only scheduler surface; applications own any synchronous integration boundary.
+- Read the Docs configuration, public-API-only reference pages, copyable examples, and
+  observed output.
+- Cross-platform CI, dependency auditing, automated dependency updates, and clean
+  distribution smoke tests.
+- Initial asyncio-first refresh engine with discovery, fingerprinting,
+  dependency-aware planning, bounded execution, transactional state, events,
+  triggers, and schedulers.

refresh_engine-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+## Setup
+
+Use Python 3.12 and `uv`:
+
+```text
+uv sync --frozen
+```
+
+Runtime code lives in `src/refresh_engine`; tests live in `tests`.
+
+## Quality checks
+
+Run the smallest relevant test first, then before submitting run:
+
+```text
+uv run ruff check .
+uv run black --check .
+uv run pyrefly check
+uv run pytest --cov=refresh_engine
+uv run python scripts/check_docs_examples.py
+uv run python scripts/run_examples.py
+uv run mkdocs build --strict
+uv build
+uv publish --dry-run --trusted-publishing never dist/*
+uv run python scripts/validate_distribution.py dist
+```
+
+Environment-tagged benchmark reports in `benchmarks/results/` are accepted when the
+environment and raw command are recorded. Do not include generated sites, virtual
+environments, local databases, or credentials.
+
+## Changes
+
+- Add tests for behavior changes and preserve deletion/state safety invariants.
+- Keep public APIs domain-neutral and typed.
+- Update user guides, API documentation, examples, architecture decisions, and
+  `CHANGELOG.md` when behavior changes.
+- Keep architecture rationale in the consolidated architecture decisions document.
+- Report benchmark environment and raw commands.
+
+By contributing, you agree that your contribution is licensed under Apache-2.0.

refresh_engine-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 S. Muni Harish
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

refresh_engine-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.5
+Name: refresh-engine
+Version: 0.1.0
+Summary: Production-grade generic refresh infrastructure
+Author: S. Muni Harish
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.12
+Requires-Dist: apscheduler<4,>=3.11
+Requires-Dist: networkx<4,>=3.6
+Requires-Dist: structlog<26,>=25.4
+Requires-Dist: tenacity<10,>=9.1
+Description-Content-Type: text/markdown
+
+# refresh-engine
+
+`refresh-engine` is an asyncio-first, domain-neutral Python library for discovering
+resources, detecting changes, planning dependency-aware work, and executing
+application-defined refresh operations safely.
+
+## Features
+
+- full, incremental, targeted, and dependency-aware refresh modes
+- deterministic fingerprints and reliable cheap pre-checks
+- bounded concurrency, retries, timeouts, and overlap policies
+- transactional state with an in-memory default and application-injected durable stores
+- asyncio and externally managed scheduling
+- typed public protocols and ABC inheritance points
+- native `structlog` lifecycle logging with configurable processors and redaction
+
+Requires Python 3.12.
+
+`RefreshEngine` uses `InMemoryStateStore` when `store` is omitted. Applications can
+inject a SQLite, PostgreSQL, or other adapter through the public `StateStore`
+protocol or `StateStoreABC`:
+
+```python
+engine = RefreshEngine(source, operation, store=my_store)
+```
+
+SQLite and PostgreSQL reference adapters are provided under
+[`examples/`](examples/README.md); database clients are not part of the production
+package.
+
+## Quick start
+
+```python
+import asyncio
+from refresh_engine import (
+    DiscoveryResult, PlanAction, RefreshEngine, Resource, ResourceSnapshot,
+)
+
+class Source:
+    async def discover(self):
+        async def resources():
+            yield Resource("alpha")
+        return DiscoveryResult(resources())
+
+    async def snapshot(self, resource):
+        return ResourceSnapshot(resource.resource_id, content={"value": 1})
+
+async def apply(resource, snapshot, action, request):
+    assert resource is not None
+    print(action, resource.resource_id)
+
+async def main():
+    engine = RefreshEngine(Source(), apply)
+    result = await engine.refresh()
+    print(result.status, result.refreshed_count)
+    await engine.close()
+
+asyncio.run(main())
+```
+
+For a `PlanAction.DELETE`, the operation receives a lightweight `Resource` carrying
+the deleted ID and `snapshot=None`; deletion handling must not expect source payloads.
+
+## Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Guides](docs/guides/index.md)
+- [API reference](docs/api/index.md)
+- [Architecture](docs/architecture/overview.md)
+- [Runnable examples](examples/README.md)
+- [Benchmarks](benchmarks/README.md)
+
+## Development and support
+
+See [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), the
+[changelog](CHANGELOG.md), and the [Apache 2.0 license](LICENSE).

refresh_engine-0.1.0/README.md

@@ -0,0 +1,76 @@
+# refresh-engine
+
+`refresh-engine` is an asyncio-first, domain-neutral Python library for discovering
+resources, detecting changes, planning dependency-aware work, and executing
+application-defined refresh operations safely.
+
+## Features
+
+- full, incremental, targeted, and dependency-aware refresh modes
+- deterministic fingerprints and reliable cheap pre-checks
+- bounded concurrency, retries, timeouts, and overlap policies
+- transactional state with an in-memory default and application-injected durable stores
+- asyncio and externally managed scheduling
+- typed public protocols and ABC inheritance points
+- native `structlog` lifecycle logging with configurable processors and redaction
+
+Requires Python 3.12.
+
+`RefreshEngine` uses `InMemoryStateStore` when `store` is omitted. Applications can
+inject a SQLite, PostgreSQL, or other adapter through the public `StateStore`
+protocol or `StateStoreABC`:
+
+```python
+engine = RefreshEngine(source, operation, store=my_store)
+```
+
+SQLite and PostgreSQL reference adapters are provided under
+[`examples/`](examples/README.md); database clients are not part of the production
+package.
+
+## Quick start
+
+```python
+import asyncio
+from refresh_engine import (
+    DiscoveryResult, PlanAction, RefreshEngine, Resource, ResourceSnapshot,
+)
+
+class Source:
+    async def discover(self):
+        async def resources():
+            yield Resource("alpha")
+        return DiscoveryResult(resources())
+
+    async def snapshot(self, resource):
+        return ResourceSnapshot(resource.resource_id, content={"value": 1})
+
+async def apply(resource, snapshot, action, request):
+    assert resource is not None
+    print(action, resource.resource_id)
+
+async def main():
+    engine = RefreshEngine(Source(), apply)
+    result = await engine.refresh()
+    print(result.status, result.refreshed_count)
+    await engine.close()
+
+asyncio.run(main())
+```
+
+For a `PlanAction.DELETE`, the operation receives a lightweight `Resource` carrying
+the deleted ID and `snapshot=None`; deletion handling must not expect source payloads.
+
+## Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Guides](docs/guides/index.md)
+- [API reference](docs/api/index.md)
+- [Architecture](docs/architecture/overview.md)
+- [Runnable examples](examples/README.md)
+- [Benchmarks](benchmarks/README.md)
+
+## Development and support
+
+See [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), the
+[changelog](CHANGELOG.md), and the [Apache 2.0 license](LICENSE).

refresh_engine-0.1.0/SECURITY.md

@@ -0,0 +1,26 @@
+# Security policy
+
+## Supported versions
+
+The latest released minor version receives security fixes. Pre-release and older
+minor versions may require upgrading before a fix can be applied.
+
+## Reporting a vulnerability
+
+Do not open a public issue. Open the repository's **Security** tab, select
+**Advisories**, and choose **Report a vulnerability** to create a private report.
+Include affected versions, impact, reproduction steps, and any proposed mitigation.
+Do not include production secrets or personal data. If private vulnerability
+reporting is unavailable, ask the repository owner to enable it before sharing
+sensitive details.
+
+Maintainers will acknowledge a report as soon as practical, coordinate validation
+and remediation privately, and disclose after a fix is available. Avoid public
+disclosure until that coordination is complete.
+
+## Operational scope
+
+Applications control source access, operation side effects, persistence, logging, and
+secrets. Treat resource content and metadata as untrusted. Use timeouts, bounded
+concurrency, least-privilege credentials, a redacting event handler, and a durable
+transactional store appropriate to the deployment.