leapocr 0.0.1__tar.gz

leapocr-0.0.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,54 @@
+## Description
+
+<!-- Provide a brief description of your changes -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an "x" -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code refactoring
+- [ ] Test improvements
+
+## Related Issues
+
+<!-- Link any related issues here -->
+
+Closes #
+
+## Changes Made
+
+<!-- List the specific changes made in this PR -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Describe the tests you ran to verify your changes -->
+
+- [ ] Unit tests pass (`make test`)
+- [ ] Integration tests pass (if applicable)
+- [ ] Added new tests for new functionality
+- [ ] All existing tests still pass
+
+## Code Quality
+
+<!-- Confirm you've met these requirements -->
+
+- [ ] Code follows the project's style guidelines
+- [ ] Ran `make format` to format code
+- [ ] Ran `make lint` and fixed all issues
+- [ ] Ran `make type-check` and fixed all type errors
+- [ ] Added docstrings for new functions/classes
+- [ ] Updated documentation (if needed)
+- [ ] Updated CHANGELOG.md (if applicable)
+
+## Additional Context
+
+<!-- Add any other context about the PR here -->

leapocr-0.0.1/.github/PYPI_SETUP.md

@@ -0,0 +1,134 @@
+# PyPI Trusted Publishing Setup
+
+This project uses PyPI's trusted publishing feature to securely publish releases without needing API tokens.
+
+## Initial Setup (One-Time)
+
+### 1. Register the Package on PyPI (if not already registered)
+
+If this is the first release:
+
+1. Build the package locally:
+   ```bash
+   uv build
+   ```
+
+2. Manually upload the first version using an API token:
+   ```bash
+   # Create a PyPI API token at: https://pypi.org/manage/account/token/
+   uv run twine upload dist/*
+   ```
+
+### 2. Configure Trusted Publishing
+
+1. Go to https://pypi.org/manage/project/leapocr/settings/publishing/
+
+2. Scroll to "Publishing" section
+
+3. Click "Add a new pending publisher"
+
+4. Fill in the form:
+   - **PyPI Project Name**: `leapocr`
+   - **Owner**: `leapocr` (GitHub organization/user)
+   - **Repository name**: `leapocr-python`
+   - **Workflow name**: `release.yml`
+   - **Environment name**: `pypi`
+
+5. Click "Add"
+
+### 3. Create PyPI Environment in GitHub
+
+1. Go to https://github.com/leapocr/leapocr-python/settings/environments
+
+2. Click "New environment"
+
+3. Name it `pypi`
+
+4. (Optional) Add protection rules:
+   - Required reviewers (for manual approval before publish)
+   - Deployment branches (limit to `main` branch only)
+
+5. Click "Configure environment"
+
+## How It Works
+
+1. When you push a tag like `v0.1.0`:
+   ```bash
+   git tag -a v0.1.0 -m "Release v0.1.0"
+   git push origin v0.1.0
+   ```
+
+2. GitHub Actions workflow triggers (`release.yml`)
+
+3. The workflow:
+   - Builds the package
+   - Requests a short-lived token from PyPI via OIDC
+   - Uses that token to publish to PyPI
+   - Creates a GitHub release
+
+4. No API tokens needed! ✨
+
+## Security Benefits
+
+- **No long-lived tokens**: Tokens are generated per-release
+- **Scoped access**: Token only works for this specific project
+- **Audit trail**: All releases tracked in GitHub Actions
+- **Revocable**: Can be disabled/reconfigured at any time
+
+## Troubleshooting
+
+### Error: "Trusted publisher configuration does not match"
+
+This usually means:
+- The repository name is wrong
+- The workflow name doesn't match (`release.yml`)
+- The environment name doesn't match (`pypi`)
+- The tag trigger isn't configured correctly
+
+**Solution**: Double-check the PyPI publisher settings match your GitHub repository exactly.
+
+### Error: "Insufficient permissions"
+
+The workflow needs `id-token: write` permission:
+
+```yaml
+permissions:
+  contents: read
+  id-token: write  # Required for trusted publishing
+```
+
+This is already configured in `release.yml`.
+
+### Error: "Package already exists"
+
+If you're trying to upload a version that already exists on PyPI:
+
+1. Bump the version in `pyproject.toml`
+2. Create a new tag with the new version
+3. Delete the old tag if needed:
+   ```bash
+   git tag -d v0.1.0
+   git push origin :refs/tags/v0.1.0
+   ```
+
+## Testing Releases
+
+To test the release process without publishing to PyPI:
+
+1. Use TestPyPI for testing:
+   - Configure a separate trusted publisher on TestPyPI
+   - Create a test workflow that publishes to TestPyPI
+   - Test with: `pip install -i https://test.pypi.org/simple/ leapocr`
+
+2. Or run the build locally:
+   ```bash
+   make build
+   # Check the dist/ folder
+   ls -lh dist/
+   ```
+
+## References
+
+- [PyPI Trusted Publishing Guide](https://docs.pypi.org/trusted-publishers/)
+- [GitHub Actions OIDC](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+- [PyPA gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish)

leapocr-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,130 @@
+name: CI
+
+on:
+  push:
+    branches: [main, new]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint and Format Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+      - name: Run ruff lint
+        run: uv run ruff check .
+
+  type-check:
+    name: Type Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run mypy
+        run: uv run mypy leapocr/
+
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run unit tests
+        run: uv run pytest tests/unit/ -v --tb=short
+
+      - name: Run tests with coverage
+        if: matrix.python-version == '3.12'
+        run: |
+          uv run pytest tests/unit/ --cov=leapocr --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+    needs: [lint, type-check, test]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Verify build artifacts
+        run: |
+          ls -lh dist/
+          python -m pip install dist/*.whl
+          python -c "import leapocr; print(f'Installed version: {leapocr.__version__}')"
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 30

leapocr-0.0.1/.github/workflows/integration-tests.yml

@@ -0,0 +1,50 @@
+name: Integration Tests
+
+on:
+  workflow_dispatch:  # Manual trigger only
+    inputs:
+      api_base_url:
+        description: 'API Base URL'
+        required: false
+        default: 'http://localhost:8080/api/v1'
+  schedule:
+    - cron: '0 0 * * 0'  # Weekly on Sunday at midnight
+
+jobs:
+  integration-test:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    environment: integration-testing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run integration tests
+        env:
+          LEAPOCR_API_KEY: ${{ secrets.LEAPOCR_API_KEY }}
+          OCR_BASE_URL: ${{ github.event.inputs.api_base_url || 'http://localhost:8080/api/v1' }}
+        run: |
+          uv run pytest tests/integration/ -v --tb=short -m integration
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-results
+          path: |
+            pytest-report.xml
+            pytest-coverage.xml
+          retention-days: 30

leapocr-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,123 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: read
+  id-token: write  # Required for trusted publishing to PyPI
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Verify version matches tag
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          if [ "$TAG" != "$VERSION" ]; then
+            echo "Error: Tag version ($TAG) does not match package version ($VERSION)"
+            exit 1
+          fi
+          echo "Version check passed: $VERSION"
+
+      - name: Build package
+        run: uv build
+
+      - name: Verify build artifacts
+        run: |
+          ls -lh dist/
+          echo "Build artifacts:"
+          echo "$(ls dist/)"
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/leapocr/
+
+    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
+        with:
+          print-hash: true
+
+  create-release:
+    name: Create GitHub Release
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract release notes
+        id: extract-notes
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: Release v${{ steps.extract-notes.outputs.version }}
+          body: |
+            ## Installation
+
+            ```bash
+            pip install leapocr==${{ steps.extract-notes.outputs.version }}
+            ```
+
+            Or using uv:
+
+            ```bash
+            uv add leapocr==${{ steps.extract-notes.outputs.version }}
+            ```
+
+            ## What's Changed
+
+            See the [changelog](https://github.com/leapocr/leapocr-python/blob/main/CHANGELOG.md) for details.
+
+            ## Documentation
+
+            - [Documentation](https://docs.leapocr.com)
+            - [Examples](https://github.com/leapocr/leapocr-python/tree/main/examples)
+
+            ---
+
+            **Full Changelog**: https://github.com/leapocr/leapocr-python/compare/v${{ steps.extract-notes.outputs.version }}...HEAD
+          draft: false
+          prerelease: false
+          generate_release_notes: true

leapocr-0.0.1/.gitignore

@@ -0,0 +1,216 @@
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

leapocr-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12