tapra 0.1.1__tar.gz

tapra-0.1.1/.gitignore

@@ -0,0 +1,64 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.idea/
+# clerk configuration (can include secrets)
+/.clerk/
+
+# agent tooling
+.agents/
+skills-lock.json
+
+# cursor 
+.cursorrules
+/memory-bank
+
+# Sentry Config File
+.env.sentry-build-plugin
+
+# Fern scratch output (fern write-definition)
+fern/.definition
+# Fern generation metadata embeds the source commit, so it never matches
+sdks/**/.fern/
+# SDK build and test artifacts
+sdks/**/node_modules/
+sdks/**/dist/
+sdks/**/__pycache__/
+sdks/**/*.egg-info/

tapra-0.1.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.5
+Name: tapra
+Version: 0.1.1
+Summary: Official Python SDK for the Tapra API: Tunisian code-switching transcription, speech, translation, and script conversion.
+License: Proprietary
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic>=1.9.2
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp<4,>=3.10.0; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
+Provides-Extra: realtime
+Requires-Dist: websockets>=13; extra == 'realtime'
+Description-Content-Type: text/markdown
+
+# Tapra Python SDK
+
+Official Python client for the Tapra API: Tunisian Arabic / French / English code-switching
+transcription, speech, translation, and Arabizi ↔ Arabic conversion.
+
+```bash
+pip install "tapra[realtime]"   # drop [realtime] if you only use the REST endpoints
+```
+
+```python
+from tapra import Tapra
+
+client = Tapra(base_url="https://api.example.com")  # api_key defaults to TAPRA_API_KEY
+
+with open("meeting.m4a", "rb") as audio:
+    transcript = client.transcriptions.create(file=audio, timestamps="word")
+print(transcript.text)
+
+client.script.convert(text="3lech 7abit l9anoun?", direction="ZI2AR")
+for event in client.translations.create_stream(input="عندي برشا خدمة", target="French"):
+    print(event.type, event.delta)
+```
+
+Async: `AsyncTapra` has the same methods. Errors raise typed exceptions
+(`PaymentRequiredError` for HTTP 402, `UnauthorizedError`, …) whose `.body.error` holds
+`type` and `message`. Pass `idempotency_key=` to retry metered requests safely, and use
+`client.<resource>.with_raw_response.<method>()` to read `x-tapra-cost-tnd`.
+
+## Realtime transcription
+
+```python
+from tapra import connect_realtime
+
+async with connect_realtime(base_url="https://api.example.com", language="ar-AR") as session:
+    for chunk in pcm_chunks:            # mono pcm_s16le, 16 kHz
+        await session.send_audio(chunk)
+    final = await session.stop()
+print(final.text, final.usage)
+```
+
+## Development
+
+`src/tapra/` is generated by Fern from `openapi/tapra-api.json`; do not edit it by hand.
+`src/tapra/realtime.py` is hand-written (kept by `.fernignore`). Tests: `sdks/tests/python`.

tapra-0.1.1/README.md

@@ -0,0 +1,44 @@
+# Tapra Python SDK
+
+Official Python client for the Tapra API: Tunisian Arabic / French / English code-switching
+transcription, speech, translation, and Arabizi ↔ Arabic conversion.
+
+```bash
+pip install "tapra[realtime]"   # drop [realtime] if you only use the REST endpoints
+```
+
+```python
+from tapra import Tapra
+
+client = Tapra(base_url="https://api.example.com")  # api_key defaults to TAPRA_API_KEY
+
+with open("meeting.m4a", "rb") as audio:
+    transcript = client.transcriptions.create(file=audio, timestamps="word")
+print(transcript.text)
+
+client.script.convert(text="3lech 7abit l9anoun?", direction="ZI2AR")
+for event in client.translations.create_stream(input="عندي برشا خدمة", target="French"):
+    print(event.type, event.delta)
+```
+
+Async: `AsyncTapra` has the same methods. Errors raise typed exceptions
+(`PaymentRequiredError` for HTTP 402, `UnauthorizedError`, …) whose `.body.error` holds
+`type` and `message`. Pass `idempotency_key=` to retry metered requests safely, and use
+`client.<resource>.with_raw_response.<method>()` to read `x-tapra-cost-tnd`.
+
+## Realtime transcription
+
+```python
+from tapra import connect_realtime
+
+async with connect_realtime(base_url="https://api.example.com", language="ar-AR") as session:
+    for chunk in pcm_chunks:            # mono pcm_s16le, 16 kHz
+        await session.send_audio(chunk)
+    final = await session.stop()
+print(final.text, final.usage)
+```
+
+## Development
+
+`src/tapra/` is generated by Fern from `openapi/tapra-api.json`; do not edit it by hand.
+`src/tapra/realtime.py` is hand-written (kept by `.fernignore`). Tests: `sdks/tests/python`.

tapra-0.1.1/pyproject.toml

@@ -0,0 +1,30 @@
+# Package wrapper for the Fern-generated client in src/tapra (never edit generated files;
+# src/tapra/realtime.py is hand-written and kept by src/tapra/.fernignore).
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "tapra"
+version = "0.1.1"
+description = "Official Python SDK for the Tapra API: Tunisian code-switching transcription, speech, translation, and script conversion."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Proprietary" }
+dependencies = [
+  "httpx>=0.21.2",
+  "pydantic>=1.9.2",
+  "typing_extensions>=4.0.0",
+]
+
+[project.optional-dependencies]
+realtime = ["websockets>=13"]
+aiohttp = ["aiohttp>=3.10.0,<4", "httpx-aiohttp>=0.1.8"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/tapra"]
+exclude = ["src/tapra/tests", "src/tapra/*.md"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/tapra", "README.md"]
+exclude = ["src/tapra/tests"]

tapra-0.1.1/src/tapra/.fernignore

@@ -0,0 +1 @@
+realtime.py

tapra-0.1.1/src/tapra/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- pip
+- poetry
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+poetry install
+```
+
+### Building
+
+Build the project:
+
+```bash
+poetry build
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+poetry run pytest
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+poetry run ruff check .
+poetry run ruff format .
+```
+
+### Type Checking
+
+Run the type checker:
+
+```bash
+poetry run mypy .
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `src/` - API client classes and types
+- Most Python files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Python SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/python-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `poetry run pytest`
+4. Run linting and formatting: `poetry run ruff check .` and `poetry run ruff format .`
+5. Run type checking: `poetry run mypy .`
+6. Build the project: `poetry build`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run `poetry run ruff format .` and `poetry run ruff check .` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

tapra-0.1.1/src/tapra/README.md

@@ -0,0 +1,205 @@
+# Tapra Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Tapra%2FPython)
+[![pypi](https://img.shields.io/pypi/v/tapra)](https://pypi.python.org/pypi/tapra)
+
+The Tapra Python library provides convenient access to the Tapra APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Streaming](#streaming)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install tapra
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from tapra import Tapra
+
+client = Tapra(
+    api_key="<token>",
+)
+
+client.transcriptions.create(
+    file="example_file",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from tapra import Tapra
+from tapra.environment import TapraEnvironment
+
+client = Tapra(
+    environment=TapraEnvironment.DEFAULT,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from tapra import AsyncTapra
+
+client = AsyncTapra(
+    api_key="<token>",
+)
+
+
+async def main() -> None:
+    await client.transcriptions.create(
+        file="example_file",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from tapra.core.api_error import ApiError
+
+try:
+    client.transcriptions.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Streaming
+
+The SDK supports streaming responses, as well, the response will be a generator that you can loop over.
+
+```python
+from tapra import Tapra
+
+client = Tapra(
+    api_key="<token>",
+)
+
+client.translations.create_stream(
+    input="input",
+)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from tapra import Tapra
+
+client = Tapra(...)
+response = client.transcriptions.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.transcriptions.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from tapra import Tapra
+
+client = Tapra(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.transcriptions.create(..., request_options={
+    "timeout": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from tapra import Tapra
+
+client = Tapra(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!