Skip to content

Adds comprehensive README documentation #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
sam-s10s merged 6 commits into from
Dec 30, 2025
Merged

Adds comprehensive README documentation #70

sam-s10s merged 6 commits into from
Dec 30, 2025

Conversation

@Zultran
Copy link
Contributor

@Zultran Zultran commented Dec 17, 2025

Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK.

The README includes:

  • Quick start instructions for installation and basic usage
  • Information on key features, use cases, and integration examples
  • Documentation links and migration guides
  • Information about Speechmatics technology
  • Links to resources and community support

@Zultran
Adds comprehensive README documentation
72ca882 
Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK.

The README includes:
- Quick start instructions for installation and basic usage
- Information on key features, use cases, and integration examples
- Documentation links and migration guides
- Information about Speechmatics technology
- Links to resources and community support
@Zultran
Removes bold formatting from migration guide links
a0cd645 
Updates the README to remove bold formatting from the "Full Migration Guides" section.
This improves the visual consistency of the document and avoids unnecessary emphasis on the links.
@Zultran Zultran self-assigned this Dec 17, 2025
@Zultran Zultran requested a review from sam-s10s December 17, 2025 14:11
@Zultran Zultran added the documentation Improvements or additions to documentation label Dec 17, 2025
ArchieMcM234
ArchieMcM234 reviewed Dec 17, 2025
View reviewed changes
@Zultran
Updates examples and adds env variable
7e5acd5 
Refactors the examples in the README to use environment variables
for the API key and includes an async close on the client in the
batch example. Also adds prefer_current_speaker to the speaker
diarization config example.
@Zultran
Updates README with usage examples and features
8cc65d6 
Enhances the README with detailed examples for batch,
realtime, TTS, and voice agent functionalities.

Also, includes installation instructions, key features,
and use cases for the Speechmatics Python SDK.
@Zultran
Fixed broken status page link to README
5b22d7d
LArmstrongDev
LArmstrongDev previously requested changes Dec 22, 2025
View reviewed changes
Copy link

@LArmstrongDev LArmstrongDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, looks good! Most of my comments are small things to polish and ensure high quality.

My comments cover a few common themes, especially:

  • Layout - making sure to use content nested under headers appropriately, and considering adding in a list at the top of a section, then going into further details - since it's really hard to navigate through information in some of the longer sections (especially with code snippets too!)
  • Capitalisation - need to have a consistent approach for capitalisation of headers.
  • Speech-to-text vs Speech to text
  • Code comments - let's make sure the code examples include suitable comments to make it easy to understand at a glance and demonstrate good programming practices.

@LArmstrongDev
Copy link

LArmstrongDev commented Dec 22, 2025 •
edited
Loading

Also, not related to your changes, but I spotted a formatting issue you could also fix up easily.

In the "Migrating from speechmatics-python?" section, the could you change the Tick button emoji points to actually be bullet points? They could also include the emoji too. ( e.g. - Tick button ...)

Thanks.

@Zultran
Enhances README with examples and details
c3a577a 
Updates the README to include more detailed examples for batch transcription, realtime streaming, text-to-speech, and voice agent functionalities.

Adds sections on key features like speaker diarization, custom dictionaries, audio intelligence, and translation with corresponding code snippets.

Provides information on framework integrations, focusing on LiveKit Agents and Pipecat AI, improving user understanding and adoption.
@sam-s10s
Copy link
Member

sam-s10s commented Dec 30, 2025

@Zultran - it looks like you have gone through the comments from @LArmstrongDev - thank you. Let's remove the block and get this merged.

@sam-s10s sam-s10s dismissed LArmstrongDev’s stale review December 30, 2025 12:20

All comments have been addressed. Thanks Lorna for the review.

@sam-s10s sam-s10s merged commit 624f014 into main Dec 30, 2025
25 checks passed
@sam-s10s sam-s10s deleted the feature/readme-enhancments branch December 30, 2025 12:21
sam-s10s added a commit that referenced this pull request Dec 30, 2025
@sam-s10s
Squashed commit of the following:
12f56fd 
commit 624f014
Author: Zultran <edgar.adamovics@speechmatics.com>
Date:   Tue Dec 30 12:20:58 2025 +0000

    Adds comprehensive README documentation (#70)

    * Adds comprehensive README documentation

    Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK.

    The README includes:
    - Quick start instructions for installation and basic usage
    - Information on key features, use cases, and integration examples
    - Documentation links and migration guides
    - Information about Speechmatics technology
    - Links to resources and community support

    * Removes bold formatting from migration guide links

    Updates the README to remove bold formatting from the "Full Migration Guides" section.
    This improves the visual consistency of the document and avoids unnecessary emphasis on the links.

    * Updates examples and adds env variable

    Refactors the examples in the README to use environment variables
    for the API key and includes an async close on the client in the
    batch example. Also adds prefer_current_speaker to the speaker
    diarization config example.

    * Updates README with usage examples and features

    Enhances the README with detailed examples for batch,
    realtime, TTS, and voice agent functionalities.

    Also, includes installation instructions, key features,
    and use cases for the Speechmatics Python SDK.

    * Fixed broken status page link to README

    * Enhances README with examples and details

    Updates the README to include more detailed examples for batch transcription, realtime streaming, text-to-speech, and voice agent functionalities.

    Adds sections on key features like speaker diarization, custom dictionaries, audio intelligence, and translation with corresponding code snippets.

    Provides information on framework integrations, focusing on LiveKit Agents and Pipecat AI, improving user understanding and adoption.

commit cb48e21
Author: Sam Sykes <sams@speechmatics.com>
Date:   Mon Dec 22 10:45:11 2025 +0100

    Reduce RT logging in Voice SDK (#72)

    ## What's Changed
    - Lowered logging of the RT AsyncClient to reduce debug noise
    - Bumped ORT / ONNX runtime dependency requirement

commit 3a247b0
Author: Sam Sykes <sams@speechmatics.com>
Date:   Mon Dec 22 10:39:02 2025 +0100

    Fix for when diarization is not enabled (#71)

    ## What's Changed
    - When diarization is not enabled, all speakers are identified as `UU`.

commit 95ca9b6
Author: Sam Sykes <sams@speechmatics.com>
Date:   Wed Dec 17 09:48:32 2025 +0100

    fix to use rt 0.5.3 (#69)

commit cecb235
Author: Sam Sykes <sams@speechmatics.com>
Date:   Tue Dec 16 20:18:01 2025 +0100

    fix to SSL for AsyncClient WebSocket (#68)

    Fix so `ws://` connections do not fail.
sam-s10s added a commit that referenced this pull request Dec 30, 2025
@sam-s10s
Squashed commit of the following:
2721675 
commit 6c0b718
Author: Sam Sykes <sams@speechmatics.com>
Date:   Tue Dec 30 13:14:32 2025 +0000

    Prettier override.

commit d113d69
Author: Sam Sykes <sams@speechmatics.com>
Date:   Tue Dec 30 12:35:06 2025 +0000

    TIP fix

commit b62a618
Author: Sam Sykes <sams@speechmatics.com>
Date:   Tue Dec 30 12:30:20 2025 +0000

    Updated integration examples. Includes linting of the README.

commit 624f014
Author: Zultran <edgar.adamovics@speechmatics.com>
Date:   Tue Dec 30 12:20:58 2025 +0000

    Adds comprehensive README documentation (#70)

    * Adds comprehensive README documentation

    Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK.

    The README includes:
    - Quick start instructions for installation and basic usage
    - Information on key features, use cases, and integration examples
    - Documentation links and migration guides
    - Information about Speechmatics technology
    - Links to resources and community support

    * Removes bold formatting from migration guide links

    Updates the README to remove bold formatting from the "Full Migration Guides" section.
    This improves the visual consistency of the document and avoids unnecessary emphasis on the links.

    * Updates examples and adds env variable

    Refactors the examples in the README to use environment variables
    for the API key and includes an async close on the client in the
    batch example. Also adds prefer_current_speaker to the speaker
    diarization config example.

    * Updates README with usage examples and features

    Enhances the README with detailed examples for batch,
    realtime, TTS, and voice agent functionalities.

    Also, includes installation instructions, key features,
    and use cases for the Speechmatics Python SDK.

    * Fixed broken status page link to README

    * Enhances README with examples and details

    Updates the README to include more detailed examples for batch transcription, realtime streaming, text-to-speech, and voice agent functionalities.

    Adds sections on key features like speaker diarization, custom dictionaries, audio intelligence, and translation with corresponding code snippets.

    Provides information on framework integrations, focusing on LiveKit Agents and Pipecat AI, improving user understanding and adoption.

commit cb48e21
Author: Sam Sykes <sams@speechmatics.com>
Date:   Mon Dec 22 10:45:11 2025 +0100

    Reduce RT logging in Voice SDK (#72)

    ## What's Changed
    - Lowered logging of the RT AsyncClient to reduce debug noise
    - Bumped ORT / ONNX runtime dependency requirement

commit 3a247b0
Author: Sam Sykes <sams@speechmatics.com>
Date:   Mon Dec 22 10:39:02 2025 +0100

    Fix for when diarization is not enabled (#71)

    ## What's Changed
    - When diarization is not enabled, all speakers are identified as `UU`.

commit 95ca9b6
Author: Sam Sykes <sams@speechmatics.com>
Date:   Wed Dec 17 09:48:32 2025 +0100

    fix to use rt 0.5.3 (#69)

commit cecb235
Author: Sam Sykes <sams@speechmatics.com>
Date:   Tue Dec 16 20:18:01 2025 +0100

    fix to SSL for AsyncClient WebSocket (#68)

    Fix so `ws://` connections do not fail.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ArchieMcM234 ArchieMcM234 ArchieMcM234 left review comments

@LArmstrongDev LArmstrongDev LArmstrongDev left review comments

@sam-s10s sam-s10s sam-s10s approved these changes

Assignees

@Zultran Zultran

Labels

documentation Improvements or additions to documentation

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Zultran @LArmstrongDev @sam-s10s @ArchieMcM234