eventsource-py 0.1.0__tar.gz

eventsource_py-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug Report
+description: Report a bug or unexpected behavior
+labels: ["bug"]
+---
+
+## Description
+
+A clear and concise description of the bug.
+
+## Steps to Reproduce
+
+1. Step one
+2. Step two
+3. ...
+
+## Expected Behavior
+
+What you expected to happen.
+
+## Actual Behavior
+
+What actually happened.
+
+## Environment
+
+- Python version: [e.g., 3.11.5]
+- eventsource-client version: [e.g., 0.1.0]
+- OS: [e.g., Ubuntu 22.04, macOS 14.0, Windows 11]
+
+## Additional Context
+
+Add any other context, stack traces, or screenshots.

eventsource_py-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://[ORGANIZATION].github.io/eventsource-py
+    about: Check our documentation for answers
+  - name: Questions & Discussions
+    url: https://github.com/[ORGANIZATION]/eventsource-py/discussions
+    about: Ask questions and discuss ideas

eventsource_py-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature Request
+description: Suggest a new feature or enhancement
+labels: ["enhancement"]
+---
+
+## Problem Statement
+
+Describe the problem you're trying to solve or the limitation you've encountered.
+
+## Proposed Solution
+
+Describe the solution you'd like to see.
+
+## Alternatives Considered
+
+What alternatives have you considered?
+
+## Additional Context
+
+Add any other context, mockups, or examples.

eventsource_py-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Summary
+
+Brief description of what this PR does.
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation update
+- [ ] Refactoring (no functional changes)
+- [ ] Tests only
+
+## Checklist
+
+- [ ] My code follows the project's code style
+- [ ] I have added tests that prove my fix/feature works
+- [ ] All new and existing tests pass
+- [ ] I have updated the documentation (if applicable)
+- [ ] I have updated the CHANGELOG.md
+- [ ] I have added type hints to new code
+
+## Related Issues
+
+Closes #(issue number)
+
+## Additional Notes
+
+Any additional context for reviewers.

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

@@ -0,0 +1,162 @@
+# CI Workflow
+# Runs linting, type checking, and tests on push and pull requests
+#
+# Jobs:
+# - lint: ruff check and format verification
+# - type-check: mypy strict type checking
+# - test: pytest with coverage (matrix: Python 3.11, 3.12)
+
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_call:  # Allow release workflow to call this
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  # Linting with ruff
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run ruff check
+        run: ruff check .
+
+      - name: Run ruff format check
+        run: ruff format --check .
+
+  # Type checking with mypy
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev,all]"
+
+      - name: Run mypy
+        run: mypy src/
+
+  # Testing with pytest
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.11', '3.12']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev,all]"
+
+      - name: Run tests
+        run: |
+          pytest --cov=src/eventsource --cov-report=xml --cov-report=term-missing \
+            -m "not integration and not postgres and not redis and not e2e"
+
+      - name: Upload coverage report
+        if: matrix.python-version == '3.11'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+          retention-days: 7
+
+  # Integration tests (optional, requires services)
+  integration:
+    runs-on: ubuntu-latest
+    needs: [lint, type-check, test]
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: test
+          POSTGRES_DB: eventsource_test
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev,all]"
+
+      - name: Run integration tests
+        env:
+          DATABASE_URL: postgresql://test:test@localhost:5432/eventsource_test
+          REDIS_URL: redis://localhost:6379
+        run: |
+          pytest -m "integration or postgres or redis" --cov=src/eventsource --cov-report=term-missing

eventsource_py-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,145 @@
+# Documentation CI/CD Workflow
+# Builds, validates, and deploys documentation to GitHub Pages
+#
+# Triggers:
+# - Push to main (docs paths) -> Build + Deploy
+# - Pull requests (docs paths) -> Build only (no deploy)
+# - Manual dispatch -> Build + Deploy (if on main)
+
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'src/**/*.py'  # For API doc generation
+      - 'examples/**'  # Example files
+      - 'scripts/validate_examples.py'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'src/**/*.py'
+      - 'examples/**'
+      - 'scripts/validate_examples.py'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+# Allow only one concurrent deployment, skip in-progress for PRs
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+# Sets permissions of the GITHUB_TOKEN for Pages deployment
+permissions:
+  contents: read
+
+jobs:
+  # Build documentation
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for git-based plugins
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Upload artifact for GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+      - name: Upload artifact for PR review
+        if: github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-preview
+          path: site/
+          retention-days: 7
+
+  # Validate code examples
+  validate-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Install package
+        run: |
+          pip install --upgrade pip
+          pip install -e .
+
+      - name: Validate example syntax
+        run: python scripts/validate_examples.py --syntax
+
+      - name: Run examples
+        run: python scripts/validate_examples.py
+
+  # Check for broken links
+  link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: >-
+            --verbose
+            --no-progress
+            --accept 200,204,206
+            --exclude-mail
+            --exclude-path './site'
+            --exclude 'your-org'
+            --exclude 'localhost'
+            --exclude '127.0.0.1'
+            'docs/**/*.md'
+            'README.md'
+          fail: true
+
+  # Deploy to GitHub Pages (only on push to main)
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [build, link-check, validate-examples]
+    runs-on: ubuntu-latest
+
+    # Grant permissions for GitHub Pages deployment
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

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

@@ -0,0 +1,197 @@
+# Release Workflow
+# Publishes package to PyPI when a version tag is pushed
+#
+# Triggers on tags matching v* (e.g., v0.1.0, v1.0.0a1)
+# - Stable versions (v1.0.0) -> PyPI
+# - Pre-releases (v1.0.0a1, v1.0.0b1) -> TestPyPI
+# - Release candidates (v1.0.0rc1) -> PyPI (marked as pre-release)
+
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write      # For GitHub Release creation
+  id-token: write      # For Trusted Publishing (OIDC)
+
+jobs:
+  # Validate release tag and extract version info
+  validate:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      is_prerelease: ${{ steps.version.outputs.is_prerelease }}
+      publish_target: ${{ steps.version.outputs.publish_target }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: version
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          echo "version=$TAG" >> $GITHUB_OUTPUT
+
+          # Determine if this is a pre-release and where to publish
+          if [[ "$TAG" =~ (a|b)[0-9]+ ]]; then
+            # Alpha or Beta -> TestPyPI
+            echo "is_prerelease=true" >> $GITHUB_OUTPUT
+            echo "publish_target=testpypi" >> $GITHUB_OUTPUT
+          elif [[ "$TAG" =~ rc[0-9]+ ]]; then
+            # Release candidate -> PyPI but marked as pre-release
+            echo "is_prerelease=true" >> $GITHUB_OUTPUT
+            echo "publish_target=pypi" >> $GITHUB_OUTPUT
+          else
+            # Stable release -> PyPI
+            echo "is_prerelease=false" >> $GITHUB_OUTPUT
+            echo "publish_target=pypi" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Validate version matches pyproject.toml
+        run: |
+          pip install tomli
+          PYPROJECT_VERSION=$(python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          if [[ "${{ steps.version.outputs.version }}" != "$PYPROJECT_VERSION" ]]; then
+            echo "::error::Tag version (${{ steps.version.outputs.version }}) does not match pyproject.toml ($PYPROJECT_VERSION)"
+            exit 1
+          fi
+          echo "Version validated: $PYPROJECT_VERSION"
+
+  # Run CI checks (reuse existing workflow)
+  ci:
+    needs: validate
+    uses: ./.github/workflows/ci.yml
+
+  # Build distribution packages
+  build:
+    needs: ci
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # Publish to PyPI (stable releases and RCs)
+  publish-pypi:
+    needs: [validate, build]
+    if: needs.validate.outputs.publish_target == 'pypi'
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  # Publish to TestPyPI (alpha and beta releases)
+  publish-testpypi:
+    needs: [validate, build]
+    if: needs.validate.outputs.publish_target == 'testpypi'
+    runs-on: ubuntu-latest
+    environment: testpypi
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  # Create GitHub Release
+  github-release:
+    needs: [validate, build, publish-pypi, publish-testpypi]
+    if: always() && needs.build.result == 'success' && (needs.publish-pypi.result == 'success' || needs.publish-testpypi.result == 'success' || needs.publish-pypi.result == 'skipped' || needs.publish-testpypi.result == 'skipped')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Extract changelog for this version
+        id: changelog
+        run: |
+          VERSION=${{ needs.validate.outputs.version }}
+          # Extract the section for this version from CHANGELOG.md
+          # This captures everything between ## [VERSION] and the next ## [
+          CONTENT=$(awk "/^## \[$VERSION\]/{flag=1; next} /^## \[/{flag=0} flag" CHANGELOG.md)
+
+          # Handle multi-line content for GitHub Actions
+          echo "content<<EOF" >> $GITHUB_OUTPUT
+          echo "$CONTENT" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          prerelease: ${{ needs.validate.outputs.is_prerelease }}
+          body: |
+            ## What's Changed
+
+            ${{ steps.changelog.outputs.content }}
+
+            ## Installation
+
+            ```bash
+            pip install eventsource-py==${{ needs.validate.outputs.version }}
+            ```
+          generate_release_notes: false
+
+  # Post-publish verification
+  verify:
+    needs: [validate, publish-pypi]
+    if: needs.publish-pypi.result == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Wait for PyPI propagation
+        run: sleep 60
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install from PyPI
+        run: pip install eventsource-py==${{ needs.validate.outputs.version }}
+
+      - name: Verify import and version
+        run: |
+          python -c "import eventsource; print(f'Installed version: {eventsource.__version__}')"
+          python -c "from eventsource import DomainEvent, InMemoryEventStore; print('Basic imports successful')"

eventsource_py-0.1.0/.gitignore

@@ -0,0 +1,96 @@
+docs/futures/
+docs/tasks/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.project
+.pydevproject
+.settings/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Local development
+*.local
+.env.local
+.env.*.local
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# MkDocs documentation site
+site/