machinera 0.1.0__tar.gz

machinera-0.1.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    groups:
+      actions-minor-patch:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    versioning-strategy: lockfile-only
+    groups:
+      uv-minor-patch:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]

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

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --locked --group dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run mypy --strict src
+      - run: uv run pytest -q
+  test-minimum:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.10"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: python -m pip install 'pip>=25.1'
+      - run: python -m pip install -e . --group dev 'pydantic==2.0.*' 'httpx==0.27.*'
+      - run: pytest -q
+  lock:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - run: uv lock --check
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: python -m pip install 'build==1.6.1' 'twine==7.0.0'
+      - run: python -m build
+      - run: twine check dist/*
+      - name: Check distribution versions
+        run: python scripts/check_release.py "v$(sed -n 's/^__version__ = "\(.*\)"$/\1/p' src/machinera/_version.py)"
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: distributions
+          path: dist/*
+  wheel-import:
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    container: python:3.12-slim
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: distributions
+          path: dist
+      - run: python -m pip install dist/*.whl
+      - run: python -c "import machinera; from importlib.metadata import version; assert machinera.__version__ == version('machinera')"

machinera-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,99 @@
+name: Publish
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    if: github.repository == 'machinera-labs/machinera-python'
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.12"
+      - run: python -m pip install 'build==1.6.1' 'twine==7.0.0'
+      - name: Require the tagged commit to be on main
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          status=$(gh api "repos/$GITHUB_REPOSITORY/compare/main...$GITHUB_SHA" --jq .status)
+          case "$status" in
+            identical|behind) ;;
+            *) echo "::error::Tagged commit $GITHUB_SHA is not on main (compare status: $status)"; exit 1 ;;
+          esac
+      - name: Wait for a successful CI run for the tagged commit
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          deadline=$(( $(date +%s) + 1800 ))
+          while :; do
+            runs=$(gh run list --repo "$GITHUB_REPOSITORY" --workflow CI --commit "$GITHUB_SHA" --json status,conclusion --jq '.[] | "\(.status) \(.conclusion)"') || runs=""
+            if grep -q ' success$' <<<"$runs"; then
+              exit 0
+            fi
+            if grep -E '^completed ' <<<"$runs" | grep -qv ' success$'; then
+              echo "::error::CI for $GITHUB_SHA completed without success"; exit 1
+            fi
+            if [ "$(date +%s)" -ge "$deadline" ]; then
+              echo "::error::Timed out after 30 minutes waiting for CI on $GITHUB_SHA"; exit 1
+            fi
+            sleep 30
+          done
+      - run: python -m build
+      - run: twine check dist/*
+      - name: Check tag and distribution versions
+        env:
+          RELEASE_TAG: ${{ github.ref_name }}
+        run: python scripts/check_release.py "$RELEASE_TAG"
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: distributions
+          path: dist/*
+          if-no-files-found: error
+  publish:
+    if: github.repository == 'machinera-labs/machinera-python'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/machinera
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: distributions
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+  release:
+    if: github.repository == 'machinera-labs/machinera-python'
+    needs: [build, publish]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: distributions
+          path: dist
+      - uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: dist/*
+          fail_on_unmatched_files: true
+          generate_release_notes: true

machinera-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+build/
+dist/
+.coverage
+htmlcov/
+.env
+.DS_Store

machinera-0.1.0/.python-version

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

machinera-0.1.0/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 — 2026-10-02
+
+### Added
+
+- Blocking `Machinera` and native asyncio `AsyncMachinera` clients for file and
+  URL transcription, job status, polling, and resumption, with context-managed
+  lifecycle and configurable concurrency.
+- File inputs from paths, binary handles, bytes, and file tuples, with supported
+  format detection and local input validation; a handle whose reads return text
+  raises `TypeError`.
+- Durable server jobs selected by `transport="job"` or an `idempotency_key`, with the
+  inline size limit `Limits.job_inline_body_bytes`, which defaults to the SDK's
+  staged-upload threshold `STAGED_UPLOAD_THRESHOLD_BYTES`; inline job submission
+  failures report `phase == "job_submit"`.
+- Automatic staged uploads for files above that limit with bounded streaming,
+  checksums, integrity validation, and safe retries. When the service reports staged
+  uploads unavailable before granting an upload, a body within the service inline
+  limit is submitted once as an inline durable job under the same operation key. Custom HTTP proxy and URL-mount settings
+  are preserved without forwarding client credentials or cookies to upload storage.
+- Idempotent submission and recovery using operation keys, upload context, and job
+  IDs, with transcription options validated before resuming bound uploads.
+- Configurable elapsed deadlines, HTTP timeouts, retry limits, headers, and
+  environment-based credentials and endpoint defaults, with service retry guidance.
+  `Retry-After` accepts seconds, including fractional values, or an HTTP date, and a
+  `retry-after-ms` header takes precedence when present.
+- Cancellation and interruption recovery context, bounded file reads, and safe
+  file cleanup that preserves caller ownership and offsets.
+  `TranscriptionInterrupted.ambiguous` is `True` when an unkeyed synchronous request
+  was interrupted and may have run.
+- Typed, frozen Pydantic transcription results and job snapshots that preserve
+  exact transcript text and retain unknown response fields in `raw`.
+  `JobSnapshot.status` is a plain string with known values in the `JobStatus` type;
+  `get_job` returns unrecognized statuses, and polling treats them as terminal and
+  raises `TerminalJobError` with the status in `last_status`.
+- Status-specific API exceptions, upload errors with sanitized storage codes,
+  and explicit deadline, ambiguous-submission, and terminal-job errors with
+  sanitized recovery context. Service errors with an `upload_` code raise
+  `UploadError`, except rate limits.
+- `APIResponseValidationError` for a malformed or unexpected response body,
+  including an upload initialization response or grant; it is never retried.
+- `TerminalIntegrityError`, raised when a job fails because the uploaded file did not
+  match; it is both an `IntegrityError` and a `TerminalJobError`.
+- A `machinera` logger with retry decisions at `DEBUG` and job status changes at
+  `INFO`, and an opt-in `MACHINERA_LOG=debug|info` environment variable.
+- Pooled, reusable connections for job status polling; uploads and submissions keep
+  connections that a deadline can close.
+- Support for Python 3.10–3.14 and every `pydantic>=2,<3` release, an API reference,
+  and runnable file, URL, large-file, recovery, error-handling, and asyncio examples
+  with offline tests. The examples construct `Machinera()` and `AsyncMachinera()`, so
+  `MACHINERA_API_KEY` and `MACHINERA_BASE_URL` apply.
+- Contribution and security policies, documented versioning, reproducible
+  development dependencies, and release artifact validation.

machinera-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+Report bugs and request features in the
+[public issue tracker](https://github.com/machinera-labs/machinera-python/issues).
+Include the SDK and Python versions, expected behavior, and a minimal reproduction
+with synthetic inputs. Remove credentials, source URLs, audio, transcripts, and
+other private data. Report vulnerabilities through [SECURITY.md](SECURITY.md).
+
+## Development
+
+Fork the [public repository](https://github.com/machinera-labs/machinera-python),
+clone your fork, and create a branch for the change. Python 3.12 is the development
+default in `.python-version`; CI tests Python 3.10, 3.11, 3.12, 3.13, and 3.14.
+
+```sh
+uv sync --locked --group dev
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy --strict src
+uv run pytest -q
+uv run python -m build
+uv run twine check dist/*
+```
+
+`uv sync --locked --group dev` installs the committed development lock, as CI does.
+With pip 25.1 or later, `python -m pip install -e . --group dev` installs the same
+tools without the lock. After intentionally changing dependencies, regenerate the
+lock with `uv lock`. Runtime dependency ranges live in `pyproject.toml`; the
+development lock does not constrain users. CI also installs the lowest supported
+runtime versions with pip to check those ranges independently of the lock.
+
+`src/machinera/_contract.py` is generated from the service's API contract; do not
+edit it by hand.
+
+Use type hints, keep strict mypy clean, and format with Ruff (100 columns).
+Keep Python 3.10 compatibility. Add focused offline tests for behavior changes,
+using `httpx.MockTransport` and the helpers in `tests/`. Do not require real API
+credentials or send network requests in tests. Preserve exact transcript text and
+caller file ownership. Add comments only to explain a non-obvious reason; keep
+public API docstrings short. End text files with one newline and no trailing spaces.
+
+## Pull requests
+
+Open a pull request against `main` in the public repository. Describe the problem,
+observable behavior, and validation performed. Keep changes focused and update
+examples, `api.md`, and the relevant category under `Unreleased` in `CHANGELOG.md`
+when behavior changes. Maintainers may integrate contributions through their own
+process, so a contribution may appear in a later release without a direct merge of
+the original pull request.
+
+## Release maintenance
+
+Review `api.md` against the exported API at every release (tests check that every
+export has an entry) and check examples on the supported Python matrix. Use
+semantic versions and move completed changelog entries into a dated release
+section when preparing a release.
+
+The tag workflow runs only in `machinera-labs/machinera-python`. Maintainers must
+configure PyPI trusted publishing for `publish.yml` and the GitHub environment
+`pypi`, with required reviewers, before publishing. A `v` tag must match the package,
+wheel, and source metadata versions. The workflow builds once, publishes the checked
+artifacts after environment approval, then attaches them to a GitHub Release.

machinera-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 [yyyy] [name of copyright owner]
+
+   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.