diff --git a/README.md b/README.md index cc86724..f96bc4f 100644 --- a/README.md +++ b/README.md @@ -7,50 +7,43 @@ > [!NOTE] > ## 🚀 Together Python SDK 2.0 is now available! > +> V1 is now considered deprecated and will be maintained in maintanence mode. All new features and development will occur in the 2.0 SDK. +> > Check out the new SDK: **[together-py](https://github.com/togethercomputer/together-py)** > > 📖 **Migration Guide:** [https://docs.together.ai/docs/pythonv2-migration-guide](https://docs.together.ai/docs/pythonv2-migration-guide) > -> ### Install the Beta +> ### Upgrade > > **Using uv (Recommended):** > ```bash -> # Install uv if you haven't already -> curl -LsSf https://astral.sh/uv/install.sh | sh -> -> # Install together python SDK -> uv add together --prerelease allow -> -> # Or upgrade an existing installation -> uv sync --upgrade-package together --prerelease allow +> uv sync --upgrade-package together > ``` > > **Using pip:** > ```bash -> pip install --pre together +> pip install --upgrade together > ``` > -> This package will be maintained until January 2026. -# Together Python API library +# Together V1 [![PyPI version](https://img.shields.io/pypi/v/together.svg)](https://pypi.org/project/together/) [![Discord](https://dcbadge.limes.pink/api/server/https://discord.gg/9Rk6sSeWEG?style=flat&theme=discord-inverted)](https://discord.com/invite/9Rk6sSeWEG) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/togethercompute.svg?style=social&label=Follow%20%40togethercompute)](https://twitter.com/togethercompute) +> Note: You are looking at the codebase for Together Python V1. The latest Together Python SDK can be found **[here.](https://github.com/togethercomputer/together-py)** + The [Together Python API Library](https://pypi.org/project/together/) is the official Python client for Together's API platform, providing a convenient way for interacting with the REST APIs and enables easy integrations with Python 3.10+ applications with easy to use synchronous and asynchronous clients. ## Installation -> 🚧 -> The Library was rewritten in v1.0.0 released in April of 2024. There were significant changes made. - To install Together Python Library from PyPI, simply run: ```shell Shell -pip install --upgrade together +pip install together ``` ### Setting up API Key diff --git a/src/together/__init__.py b/src/together/__init__.py index 0866b22..c3082b1 100644 --- a/src/together/__init__.py +++ b/src/together/__init__.py @@ -10,11 +10,13 @@ ================================================================================ Together Python SDK 2.0 is now available! -Install: pip install --pre together +Install: pip install together --upgrade +Install: uv sync --upgrade-package together New SDK: https://github.com/togethercomputer/together-py Migration guide: https://docs.together.ai/docs/pythonv2-migration-guide -This package will be maintained until January 2026. +Together V1 is now deprecated and will be maintained in maintanence mode. +All new features and development will occur in the 2.0 SDK. ================================================================================ """ @@ -28,15 +30,14 @@ console.print( Panel( "[bold cyan]Together Python SDK 2.0 is now available![/bold cyan]\n\n" - "Install the beta:\n" - "[green]pip install --pre together[/green] or " - "[green]uv add together --prerelease allow[/green]\n\n" + "Upgrade to the latest version:\n" + "[green]pip install together --upgrade[/green] or " + "[green]uv sync --upgrade-package together[/green]\n\n" "New SDK: [link=https://github.com/togethercomputer/together-py]" "https://github.com/togethercomputer/together-py[/link]\n" "Migration guide: [link=https://docs.together.ai/docs/pythonv2-migration-guide]" "https://docs.together.ai/docs/pythonv2-migration-guide[/link]\n\n" - "[dim]This package will be maintained until January 2026.\n" - "Set TOGETHER_NO_BANNER=1 to hide this message.[/dim]", + "[dim]Together V1 is now deprecated and will be maintained in maintanence mode. All new features and development will occur in the 2.0 SDK.[/dim]\n", title="🚀 New SDK Available", border_style="cyan", )