edgesync 0.2.0__tar.gz

edgesync-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }} --all-extras --dev
+
+      - name: Run tests
+        run: uv run --python ${{ matrix.python-version }} pytest --cov=edgesync --cov-report=xml
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+  typecheck:
+    name: typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Mypy
+        run: uv run mypy

edgesync-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,144 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }} --all-extras --dev
+
+      - name: Run tests
+        run: uv run --python ${{ matrix.python-version }} pytest
+
+      - name: Ruff check
+        if: matrix.python-version == '3.13'
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        if: matrix.python-version == '3.13'
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        if: matrix.python-version == '3.13'
+        run: uv run mypy
+
+  check-version:
+    name: verify tag matches VERSION file
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Compare tag to VERSION file
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          FILE_VERSION="$(tr -d '[:space:]' < VERSION)"
+          if [ "$TAG_VERSION" != "$FILE_VERSION" ]; then
+            echo "::error::tag v$TAG_VERSION does not match VERSION file ($FILE_VERSION)"
+            exit 1
+          fi
+
+  build:
+    name: build distributions
+    runs-on: ubuntu-latest
+    needs: check-version
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/project/edgesync/
+    permissions:
+      id-token: write # required for PyPI Trusted Publishing (OIDC)
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # VERSION is the single source of truth for the release version;
+          # if this version is already published (e.g. the workflow was
+          # re-run, or a tag was pushed for a version already on PyPI),
+          # skip the upload instead of failing the release.
+          skip-existing: true
+
+  github-release:
+    name: create GitHub release
+    runs-on: ubuntu-latest
+    needs: publish-pypi
+    permissions:
+      contents: write # required to create the GitHub release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Extract CHANGELOG section for this version
+        id: changelog
+        run: |
+          VERSION="$(tr -d '[:space:]' < VERSION)"
+          NOTES_FILE="$(mktemp)"
+          awk -v ver="$VERSION" '
+            $0 ~ "^## \\[" ver "\\]" { found=1; next }
+            found && (/^## \[/ || /^\[[^]]+\]: /) { exit }
+            found { print }
+          ' CHANGELOG.md > "$NOTES_FILE"
+          if [ ! -s "$NOTES_FILE" ]; then
+            echo "::error::no CHANGELOG.md section found for [$VERSION]"
+            exit 1
+          fi
+          echo "notes_file=$NOTES_FILE" >> "$GITHUB_OUTPUT"
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: EdgeSync v${{ steps.changelog.outputs.version }}
+          body_path: ${{ steps.changelog.outputs.notes_file }}
+          files: dist/*

edgesync-0.2.0/.gitignore

@@ -0,0 +1,221 @@
+# 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
+CLAUDE.md
+.serena
+.claude

edgesync-0.2.0/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2026-08-23
+
+### Added
+
+- [docs/integrations.md](docs/integrations.md): usage guidance for plain `asyncio`,
+  FastAPI, and Flask, including a ready-to-use thread bridge for running EdgeSync from
+  Flask's synchronous request handlers.
+
+### Changed
+
+- The package version is now maintained in a single `VERSION` file at the repository root
+  (read by `pyproject.toml` via Hatchling and by `edgesync.__version__` at runtime) instead
+  of being duplicated across files.
+- The release workflow now verifies the pushed tag matches `VERSION` before building, and
+  skips the PyPI upload (instead of failing) if that version has already been published.
+- GitHub release titles and notes are now generated from the matching `CHANGELOG.md`
+  section for the released version, instead of GitHub's generic auto-generated notes.
+
+## [0.1.0] - 2026-08-23
+
+### Added
+
+- `EdgeSync` client with `publish()`, `stats()`, `start()`/`close()`, and async context
+  manager support.
+- Durable SQLite-backed queue (`SQLiteStorage`) with WAL mode, configurable `synchronous`
+  durability, and lease-fenced message ownership.
+- Background `SyncWorker` with configurable polling, batch size, and concurrency.
+- Configurable retry policy (`RetryPolicy`) with exponential backoff, jitter, and optional
+  `max_attempts` before dead-lettering.
+- Dead-letter queue (`sync.dead_letters`) for inspecting, retrying, and deleting messages
+  that permanently failed or exhausted retries.
+- `HTTPTransport` with configurable idempotency header, success/retryable status code
+  classification, and connection reuse.
+- Pluggable `Transport` interface for non-HTTP destinations.
+- Multiple named destinations via `destinations={...}` / `destination=` routing.
+- Configurable queue capacity (`max_messages`, `max_storage_bytes`) with
+  `REJECT_NEW` / `DROP_OLDEST` / `DROP_LOWEST_PRIORITY` / `DEAD_LETTER` overflow policies.
+- Crash and restart recovery via expired-lease sweeps, safe across concurrent workers and
+  processes sharing the same database file.
+
+[Unreleased]: https://github.com/adhuldas/EdgeSync/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/adhuldas/EdgeSync/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/adhuldas/EdgeSync/releases/tag/v0.1.0

edgesync-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to EdgeSync
+
+Thanks for considering a contribution. This project is a small, dependency-light library, and
+that's intentional — please keep that in mind when proposing changes.
+
+## Setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+git clone https://github.com/adhuldas/EdgeSync.git
+cd EdgeSync
+uv sync
+```
+
+## Development workflow
+
+Run the full check suite before opening a PR:
+
+```bash
+uv run pytest              # tests
+uv run ruff check .        # lint
+uv run ruff format --check .  # formatting
+uv run mypy                # type check (strict, on edgesync/)
+```
+
+All four must pass. CI runs the same checks on every PR across the supported Python versions
+(3.10–3.13).
+
+## Code style
+
+- Type hints are required everywhere in `edgesync/`; `mypy --strict` is enforced.
+- Business logic must go through the `Clock` abstraction (`edgesync.utils.clock`) instead of
+  calling `datetime.now()` directly, so tests can use `FixedClock` instead of sleeping or
+  racing wall-clock time.
+- Transports only attempt delivery and classify the outcome (`DeliveryResult`) — they never
+  touch storage or retry scheduling. That's the worker's job.
+- Keep the public surface (`edgesync/__init__.py`) intentional: only export what's meant to
+  be part of the stable API.
+
+## Tests
+
+Tests are organized by what they exercise:
+
+- `tests/unit/` — pure logic with no I/O (retry backoff, config validation, models).
+- `tests/integration/` — a single component against a real dependency (SQLite, HTTP via
+  `respx`, the worker against a fake transport, the client end-to-end).
+- `tests/reliability/` — crash, restart, and concurrency scenarios that exercise the
+  interaction between storage and the worker (e.g. lease expiry recovery, concurrent workers
+  never double-claiming).
+
+New behavior should come with a test in the appropriate tier. Reliability-sensitive changes
+(anything touching `storage/`, `worker/`, or lease handling) should include or update a
+`tests/reliability/` case.
+
+## Commit / PR expectations
+
+- Keep PRs focused — one logical change per PR.
+- Write commit messages and PR descriptions that explain *why*, not just *what*.
+- If you're changing behavior described in `docs/`, update the relevant doc in the same PR.
+
+## Releasing
+
+`VERSION` (repo root) is the single source of truth for the package version — it's read by
+`pyproject.toml` (via Hatchling) and by `edgesync.__version__` at runtime. To cut a release:
+
+1. Bump the version in `VERSION` (no `v` prefix, e.g. `0.2.0`).
+2. Move the `[Unreleased]` entries in `CHANGELOG.md` under a new `## [0.2.0] - YYYY-MM-DD`
+   heading.
+3. Commit those two changes.
+4. Tag the commit and push the tag: `git tag v0.2.0 && git push origin v0.2.0`.
+
+Pushing a `vX.Y.Z` tag triggers `.github/workflows/release.yml`, which runs the full test
+suite, verifies the tag matches `VERSION`, builds the sdist/wheel, and publishes to PyPI via
+Trusted Publishing. If that version is already on PyPI (e.g. the workflow is re-run), the
+publish step is skipped rather than failing.
+
+## Reporting bugs
+
+Open a GitHub issue with:
+- EdgeSync version and Python version
+- A minimal reproduction (ideally a failing test)
+- Expected vs. actual behavior
+
+## Reporting security issues
+
+Do not open a public issue for security vulnerabilities — see [SECURITY.md](SECURITY.md).

edgesync-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 EdgeSync 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.