feat: prepare v1.0.0 release #42
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the Fish Audio Python SDK for the v1.0.0 release with significant API improvements and breaking changes.
Key Changes
- API Refactoring: Renamed
convert()method tostream()for streaming operations, introduced newconvert()method that returns complete audio asbytes - New Audio Stream Wrappers: Added
AudioStreamandAsyncAudioStreamclasses with.collect()utility method - Environment Variable Rename: Changed from
FISH_AUDIO_API_KEYtoFISH_API_KEYacross all code, tests, and documentation - Enhanced Documentation: Added comprehensive docstrings for all type classes with detailed attribute descriptions
- Development Status Update: Upgraded package classifier from "Beta" to "Production/Stable"
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/fishaudio/core/iterators.py | New file introducing AudioStream/AsyncAudioStream wrappers with collection utilities |
| src/fishaudio/resources/tts.py | Refactored TTS client: added stream() method, converted convert() to return bytes |
| src/fishaudio/core/client_wrapper.py | Updated environment variable from FISH_AUDIO_API_KEY to FISH_API_KEY |
| src/fishaudio/client.py | Updated docstrings to reference new FISH_API_KEY environment variable |
| src/fishaudio/init.py | Exported new AudioStream and AsyncAudioStream classes |
| src/fishaudio/types/*.py | Added comprehensive attribute documentation to all model classes |
| tests/unit/test_tts.py | Updated tests to use new stream() method and handle bytes-returning convert() |
| tests/unit/test_core.py | Updated environment variable in tests |
| tests/unit/test_client.py | Updated environment variable in tests |
| tests/integration/*.py | Updated to use new convert() API returning bytes instead of iterators |
| tests/integration/conftest.py | Modified save_audio helper to accept both bytes and list[bytes] |
| pyproject.toml | Updated development status classifier to Production/Stable |
| examples/*.py | Updated all examples to use new FISH_API_KEY environment variable |
| README.md | Complete rewrite with updated API examples and environment variable |
| scripts/copy_docs.py | Changed SDK documentation title from "Python SDK" to "Overview" |
| .github/workflows/python.yml | Updated CI environment variable |
| .env.example | Updated environment variable name |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Should be the final PR before we launch v1.0.0 :)