otterai-py
Unofficial Python API for otter.ai
Note: This project is a fork of gmchad/otterai-api, as the original repository appears to be abandoned. Improvements and updates will be maintained here.
Contents
Installation
Install via pip:
pip install .[dev]
or in a virtual environment:
python3 -m venv env
source env/bin/activate
pip install .[dev]
Setup
from otterai import OtterAI
otter = OtterAI()
otter.login('USERNAME', 'PASSWORD')
APIs
User
Get user-specific data:
otter.get_user()
Speeches
Get all speeches.
Optional parameters: folder, page_size, source
otter.get_speeches()
Get a speech by ID:
otter.get_speech(OTID)
Query a speech:
otter.query_speech(QUERY, OTID)
Upload a speech.
Optional parameters: content_type (default: audio/mp4)
otter.upload_speech(FILE_NAME)
Download a speech.
Optional parameters: filename (default: id), format (default: all available formats (txt,pdf,mp3,docx,srt) as a zip file)
otter.download_speech(OTID, FILE_NAME)
Move a speech to the trash:
otter.move_to_trash_bin(OTID)
Set speech title:
otter.set_speech_title(OTID, TITLE)
TODO
- Start a live speech
- Stop a live speech
- Assign a speaker to a speech transcript
Speakers
Get all speakers:
otter.get_speakers()
Create a speaker:
otter.create_speaker(SPEAKER_NAME)
Folders
Get all folders:
otter.get_folders()
Groups
Get all groups:
otter.list_groups()
Notifications
Get notification settings:
otter.get_notification_settings()
Exceptions
from otterai import OtterAIException
try:
...
except OtterAIException as e:
...
Contribution
To contribute to this project, follow these steps:
-
Create a
.envfile in the root directory with the following content:OTTERAI_USERNAME="" OTTERAI_PASSWORD="" TEST_OTTERAI_SPEECH_OTID=""
- Replace
OTTERAI_USERNAMEandOTTERAI_PASSWORDwith your Otter.ai credentials. - Replace
TEST_OTTERAI_SPEECH_OTIDwith the ID of a speech you create on Otter.ai. This is required for the tests to pass.
- Replace
-
To run the tests and the
main.pyfile, execute therun.shscript:./run.sh
-
Ensure all tests pass and make necessary updates to the tests if you modify or add functionality.
-
Submit a pull request with a clear description of your changes.
Metadata
Release files for otterai-py 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| otterai_py-0.0.2.tar.gz | 8.0 kB | Without provenance | Details for otterai_py-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| otterai_py-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for otterai_py-0.0.2-py3-none-any.whl |
Total release size: 14.4 kB
Release files / otterai_py-0.0.2.tar.gz
| Download URL | otterai_py-0.0.2.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48b3e058e8a831b9a3da05b0eebd5e5d8d9db673a4de9a8506eb9ea8d8ca8309
|
|
BLAKE2b-256 checksum How to use checksums |
43565009068b837d93f6ee1b91bab126f2f9f746ac5e473f828dcf37cc636046
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Release files / otterai_py-0.0.2-py3-none-any.whl
| Download URL | otterai_py-0.0.2-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
176a569c191494725ad69f1fa14e46c9eb7ecdb03d1661eed711b1aff50e9e88
|
|
BLAKE2b-256 checksum How to use checksums |
916805fc09e5b18c2836b4fb1aa38b76a3bf4499edd8870a0b00a70cd0efc3c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Security for otterai-py 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.