speechall 0.1.0__tar.gz

speechall-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,43 @@
+name: Publish Python Package to PyPI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish:
+    name: Build and publish Python distribution to PyPI
+    runs-on: ubuntu-latest
+    environment: release # Optional: if you have a GitHub environment for releases
+    permissions:
+      id-token: write # Required for trusted publishing, if you choose that route later
+      contents: read # Needed to check out the repository
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.9" # Or another version like "3.x" or based on pyproject.toml
+
+    - name: Install build dependencies
+      run: python -m pip install --upgrade pip build
+
+    - name: Build package
+      run: python -m build
+
+    # Test with TestPyPI first using Trusted Publishing
+    # - name: Publish package to TestPyPI
+    #   uses: pypa/gh-action-pypi-publish@release/v1
+    #   with:
+    #     repository-url: https://test.pypi.org/legacy/
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        # skip_existing: true # To skip publishing if the version already exists

speechall-0.1.0/.gitignore

@@ -0,0 +1,196 @@
+# 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/
+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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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 enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+.DS_Store

speechall-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,31 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.gitlab.com/ee/ci/README.html
+# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
+
+stages:
+  - test
+
+.pytest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=speechall
+
+pytest-3.7:
+  extends: .pytest
+  image: python:3.7-alpine
+pytest-3.8:
+  extends: .pytest
+  image: python:3.8-alpine
+pytest-3.9:
+  extends: .pytest
+  image: python:3.9-alpine
+pytest-3.10:
+  extends: .pytest
+  image: python:3.10-alpine
+pytest-3.11:
+  extends: .pytest
+  image: python:3.11-alpine

speechall-0.1.0/.openapi-generator/FILES

@@ -0,0 +1,95 @@
+.github/workflows/python.yml
+.gitignore
+.gitlab-ci.yml
+.openapi-generator-ignore
+.travis.yml
+README.md
+docs/BaseTranscriptionConfiguration.md
+docs/CreateReplacementRuleset201Response.md
+docs/CreateReplacementRulesetRequest.md
+docs/ErrorResponse.md
+docs/ExactRule.md
+docs/OpenAICreateTranslationRequestModel.md
+docs/OpenaiCompatibleCreateTranscription200Response.md
+docs/OpenaiCompatibleCreateTranslation200Response.md
+docs/RegexGroupRule.md
+docs/RegexRule.md
+docs/RemoteTranscriptionConfiguration.md
+docs/ReplacementRule.md
+docs/ReplacementRulesApi.md
+docs/SpeechToTextApi.md
+docs/SpeechToTextModel.md
+docs/TranscriptLanguageCode.md
+docs/TranscriptOutputFormat.md
+docs/TranscriptionDetailed.md
+docs/TranscriptionModelIdentifier.md
+docs/TranscriptionOnlyText.md
+docs/TranscriptionProvider.md
+docs/TranscriptionResponse.md
+docs/TranscriptionSegment.md
+docs/TranscriptionWord.md
+git_push.sh
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+speechall/__init__.py
+speechall/api/__init__.py
+speechall/api/replacement_rules_api.py
+speechall/api/speech_to_text_api.py
+speechall/api_client.py
+speechall/api_response.py
+speechall/configuration.py
+speechall/exceptions.py
+speechall/models/__init__.py
+speechall/models/base_transcription_configuration.py
+speechall/models/create_replacement_ruleset201_response.py
+speechall/models/create_replacement_ruleset_request.py
+speechall/models/error_response.py
+speechall/models/exact_rule.py
+speechall/models/open_ai_create_translation_request_model.py
+speechall/models/openai_compatible_create_transcription200_response.py
+speechall/models/openai_compatible_create_translation200_response.py
+speechall/models/regex_group_rule.py
+speechall/models/regex_rule.py
+speechall/models/remote_transcription_configuration.py
+speechall/models/replacement_rule.py
+speechall/models/speech_to_text_model.py
+speechall/models/transcript_language_code.py
+speechall/models/transcript_output_format.py
+speechall/models/transcription_detailed.py
+speechall/models/transcription_model_identifier.py
+speechall/models/transcription_only_text.py
+speechall/models/transcription_provider.py
+speechall/models/transcription_response.py
+speechall/models/transcription_segment.py
+speechall/models/transcription_word.py
+speechall/py.typed
+speechall/rest.py
+test-requirements.txt
+test/__init__.py
+test/test_base_transcription_configuration.py
+test/test_create_replacement_ruleset201_response.py
+test/test_create_replacement_ruleset_request.py
+test/test_error_response.py
+test/test_exact_rule.py
+test/test_open_ai_create_translation_request_model.py
+test/test_openai_compatible_create_transcription200_response.py
+test/test_openai_compatible_create_translation200_response.py
+test/test_regex_group_rule.py
+test/test_regex_rule.py
+test/test_remote_transcription_configuration.py
+test/test_replacement_rule.py
+test/test_replacement_rules_api.py
+test/test_speech_to_text_api.py
+test/test_speech_to_text_model.py
+test/test_transcript_language_code.py
+test/test_transcript_output_format.py
+test/test_transcription_detailed.py
+test/test_transcription_model_identifier.py
+test/test_transcription_only_text.py
+test/test_transcription_provider.py
+test/test_transcription_response.py
+test/test_transcription_segment.py
+test/test_transcription_word.py
+tox.ini

speechall-0.1.0/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.13.0

speechall-0.1.0/.openapi-generator-ignore

@@ -0,0 +1,41 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+# Custom files to preserve during regeneration
+example_transcribe.py
+simple_example.py
+EXAMPLE_README.md
+REGENERATION_GUIDE.md
+pyproject.toml
+uv.lock
+.venv/**
+*.pyc
+__pycache__/**
+Makefile
+regenerate.sh
+fix_transcription_response.py
+.gitignore
+.openapi-generator-ignore
+# Ignore OpenAI-Compatible Speech-to-Text Endpoints
+speechall/api/open_ai_compatible_speech_to_text_api.py

speechall-0.1.0/.travis.yml

@@ -0,0 +1,17 @@
+# ref: https://docs.travis-ci.com/user/languages/python
+language: python
+python:
+  - "3.7"
+  - "3.8"
+  - "3.9"
+  - "3.10"
+  - "3.11"
+  # uncomment the following if needed
+  #- "3.11-dev"  # 3.11 development branch
+  #- "nightly"  # nightly build
+# command to install dependencies
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
+# command to run tests
+script: pytest --cov=speechall

speechall-0.1.0/EXAMPLE_README.md

@@ -0,0 +1,126 @@
+# Speechall Python SDK Example
+
+This repository contains a Python SDK for the Speechall API, generated using OpenAPI Generator, with example scripts demonstrating how to use the transcribe endpoint.
+
+## Quick Start
+
+### 1. Install Dependencies
+
+Make sure you have `uv` installed, then run:
+
+```bash
+uv sync
+```
+
+### 2. Set Up Authentication
+
+Set your Speechall API token as an environment variable:
+
+```bash
+export SPEECHALL_API_TOKEN="your-api-token-here"
+```
+
+### 3. Run the Example
+
+```bash
+uv run python example_transcribe.py
+```
+
+## Features Demonstrated
+
+The example script shows how to:
+
+- **List Available Models**: Get all available speech-to-text models and their capabilities
+- **Transcribe Local Files**: Upload and transcribe audio files from your local machine
+- **Transcribe Remote URLs**: Transcribe audio files directly from URLs
+- **Advanced Features**: Use speaker diarization, custom vocabulary, and smart formatting
+
+## Available Models
+
+The SDK supports numerous speech-to-text providers and models, including:
+
+- **OpenAI**: `openai.whisper-1`, `openai.gpt-4o-transcribe`
+- **Deepgram**: `deepgram.nova-2`, `deepgram.nova-3`, `deepgram.whisper-large`
+- **AssemblyAI**: `assemblyai.best`, `assemblyai.nano`
+- **Google**: `google.enhanced`, `google.standard`
+- **Azure**: `azure.standard`
+- **Groq**: `groq.whisper-large-v3`, `groq.whisper-large-v3-turbo`
+- And many more!
+
+## Example Usage
+
+### Basic Transcription
+
+```python
+from openapi_client import ApiClient, Configuration
+from openapi_client.api.speech_to_text_api import SpeechToTextApi
+from openapi_client.models.transcription_model_identifier import TranscriptionModelIdentifier
+
+# Set up client
+configuration = Configuration()
+configuration.access_token = "your-api-token"
+api_client = ApiClient(configuration)
+api_instance = SpeechToTextApi(api_client)
+
+# Transcribe audio file
+with open("audio.wav", "rb") as f:
+    result = api_instance.transcribe(
+        model=TranscriptionModelIdentifier.OPENAI_DOT_WHISPER_MINUS_1,
+        body=f.read(),
+        language="en"
+    )
+    print(result)
+```
+
+### Advanced Features
+
+```python
+# Use advanced features like diarization and custom vocabulary
+result = api_instance.transcribe(
+    model=TranscriptionModelIdentifier.DEEPGRAM_DOT_NOVA_MINUS_2,
+    body=audio_data,
+    language="en",
+    output_format="verbose_json",
+    diarization=True,
+    custom_vocabulary=["technical", "terms"],
+    speakers_expected=2
+)
+```
+
+## Supported Audio Formats
+
+The API supports various audio formats including:
+- WAV
+- MP3
+- FLAC
+- OGG
+- M4A
+- And more (depends on the selected model/provider)
+
+## Error Handling
+
+The SDK includes proper error handling for common scenarios:
+
+```python
+from openapi_client.exceptions import ApiException
+
+try:
+    result = api_instance.transcribe(...)
+except ApiException as e:
+    print(f"API Error: {e}")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+## Next Steps
+
+1. Get your API token from the Speechall dashboard
+2. Replace the example audio file path with your actual audio file
+3. Experiment with different models and parameters
+4. Check the [Speechall API documentation](https://docs.speechall.com) for more details
+
+## Support
+
+For support and questions:
+- Check the [Speechall documentation](https://docs.speechall.com)
+- Contact support at team@speechall.com 

speechall-0.1.0/LICENSE

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

speechall-0.1.0/Makefile

@@ -0,0 +1,104 @@
+# Speechall Python SDK Makefile
+
+# Configuration
+OPENAPI_SPEC_PATH = ../speechall-openapi/openapi.yaml
+GENERATOR = python-pydantic-v1
+OUTPUT_DIR = .
+
+.PHONY: help install regenerate test example clean
+
+# Default target
+help:
+	@echo "🎙️  Speechall Python SDK Commands"
+	@echo "=================================="
+	@echo ""
+	@echo "📦 Setup:"
+	@echo "  make install     - Install dependencies with uv"
+	@echo ""
+	@echo "🔄 Code generation:"
+	@echo "  make regenerate  - Regenerate client from OpenAPI spec"
+	@echo "  make force-regen - Force regenerate (skip validation)"
+	@echo "  make fix         - Apply TranscriptionResponse oneOf fix"
+	@echo ""
+	@echo "🧪 Testing:"
+	@echo "  make test        - Run tests"
+	@echo "  make example     - Run example script"
+	@echo ""
+	@echo "🧹 Cleanup:"
+	@echo "  make clean       - Clean generated files and cache"
+
+# Install dependencies
+install:
+	@echo "📦 Installing dependencies..."
+	uv sync
+
+# Regenerate client from OpenAPI spec
+regenerate:
+	@echo "🔄 Regenerating OpenAPI client..."
+	@if [ ! -f "$(OPENAPI_SPEC_PATH)" ]; then \
+		echo "❌ Error: OpenAPI spec not found at $(OPENAPI_SPEC_PATH)"; \
+		echo "Please ensure the speechall-openapi repository is cloned"; \
+		exit 1; \
+	fi
+	./regenerate.sh
+
+# Force regenerate (for development)
+force-regen:
+	@echo "🔄 Force regenerating OpenAPI client..."
+	openapi-generator generate \
+		-i $(OPENAPI_SPEC_PATH) \
+		-g $(GENERATOR) \
+		-o $(OUTPUT_DIR) \
+		--skip-validate-spec
+	@echo "⚠️  Note: This may overwrite custom files!"
+
+# Apply TranscriptionResponse oneOf fix
+fix:
+	@echo "🔧 Applying TranscriptionResponse oneOf fix..."
+	python3 fix_transcription_response.py
+
+# Run tests
+test:
+	@echo "🧪 Running tests..."
+	uv run python -m pytest test/ -v
+
+# Run example script
+example:
+	@echo "🎤 Running example script..."
+	@if [ -z "$$SPEECHALL_API_TOKEN" ]; then \
+		echo "⚠️  Warning: SPEECHALL_API_TOKEN not set"; \
+		echo "Set it with: export SPEECHALL_API_TOKEN='your-token'"; \
+	fi
+	uv run python example_transcribe.py
+
+# Run simple example
+simple:
+	@echo "🎤 Running simple example..."
+	@if [ -z "$$SPEECHALL_API_TOKEN" ]; then \
+		echo "⚠️  Warning: SPEECHALL_API_TOKEN not set"; \
+		echo "Set it with: export SPEECHALL_API_TOKEN='your-token'"; \
+	fi
+	uv run python simple_example.py
+
+# Clean up generated files and cache
+clean:
+	@echo "🧹 Cleaning up..."
+	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
+	find . -name "*.pyc" -delete 2>/dev/null || true
+	rm -rf backup_*/ 2>/dev/null || true
+	@echo "✅ Cleanup complete"
+
+# Development helpers
+check-spec:
+	@echo "📋 Checking OpenAPI specification..."
+	@if [ -f "$(OPENAPI_SPEC_PATH)" ]; then \
+		echo "✅ OpenAPI spec found at $(OPENAPI_SPEC_PATH)"; \
+		openapi-generator validate -i $(OPENAPI_SPEC_PATH) || echo "⚠️  Validation warnings found"; \
+	else \
+		echo "❌ OpenAPI spec not found at $(OPENAPI_SPEC_PATH)"; \
+	fi
+
+# List available models (requires API token)
+list-models:
+	@echo "📋 Listing available models..."
+	@uv run python -c "import os; from openapi_client import *; from openapi_client.api.speech_to_text_api import SpeechToTextApi; config = Configuration(); config.access_token = os.getenv('SPEECHALL_API_TOKEN'); api = SpeechToTextApi(ApiClient(config)); [print(f'{m.model_id}: {m.display_name}') for m in api.list_speech_to_text_models()[:10]]" 2>/dev/null || echo "❌ Failed to list models (check your API token)"