Skip to main content

Python client for TextOps transcription API

Project description

TextOps API Client (Under Construction 🚧)

This package is currently under development. Expect changes, improvements, and possible breaking updates.

A simple Python client for the TextOps transcription API.
Easily submit audio files for transcription, check status, and retrieve results.


📦 Installation

pip install textops-api-v1

🧪 Quick Examples

Example 1: Manual submission and polling

from textops_api_v1 import TextOpsAPI

# Initialize the client with your API key
api_key = "your api key"
client = TextOpsAPI(api_key=api_key)

audio_url = "audio url"

try:
    # Submit audio for transcription
    response = client.submit_transcription(audio_url)
    job_id = response['textopsJobId']
    
    # Check status
    status = client.check_status(job_id)
    print(f"Current status: {status}")
    
    # Wait for completion
    result = client.wait_for_completion(job_id)
    if result and 'text' in result:
        print(f"Transcription complete! First 100 chars: {result['text'][:100]}...")
    else:
        print("Transcription failed or timed out.")
except Exception as e:
    print(f"Error: {e}")

Example 2: All-in-one method

from textops_api_v1 import TextOpsAPI

client = TextOpsAPI(api_key="your api key")
audio_url = "audio url"

try:
    result = client.transcribe(audio_url)
    print("Transcription complete!")
    print(f"First 100 chars: {result['text'][:100]}")
    print(f"Total length: {len(result['text'])} characters")
except Exception as e:
    print(f"Error: {e}")

⚠️ Disclaimer

This package is in alpha. APIs may change and documentation is still in progress.


📄 License

MIT


📬 Contact

For questions or issues, open a GitHub issue or reach out to your@email.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textops_api_v1-0.1.85.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textops_api_v1-0.1.85-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file textops_api_v1-0.1.85.tar.gz.

File metadata

  • Download URL: textops_api_v1-0.1.85.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.5

File hashes

Hashes for textops_api_v1-0.1.85.tar.gz
Algorithm Hash digest
SHA256 a8f4e0c46efa629faf312f608d458488fe41dde2225671548f522d8268f3b32f
MD5 48bfbf060438da14fb554fe2148189be
BLAKE2b-256 82816bcb1af98caad7d0c7f5879f02f5506b1987ac7867941a9da41694c2993d

See more details on using hashes here.

File details

Details for the file textops_api_v1-0.1.85-py3-none-any.whl.

File metadata

File hashes

Hashes for textops_api_v1-0.1.85-py3-none-any.whl
Algorithm Hash digest
SHA256 65c2ba9034c2407d9ec1f4c04f058007275c5384df70d62c617f50c52677b643
MD5 b35609b7f20d540dce6cdbcbe6c1d5bb
BLAKE2b-256 e10b5e3c25560803102ef64660ec0aa85a25f1ba28e616c189bcdae396aca7ab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page