Skip to content

Commit 35fd835

Browse files
authored
chore: Mark V1 as deprecated (#425)
* chore: Mark V1 as deprecated * fix * fix * Apply suggestion from @blainekasten
1 parent e96624e commit 35fd835

File tree

2 files changed

+17
-23
lines changed

2 files changed

+17
-23
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,43 @@
77
> [!NOTE]
88
> ## 🚀 Together Python SDK 2.0 is now available!
99
>
10+
> V1 is now considered deprecated and will be maintained in maintanence mode. All new features and development will occur in the 2.0 SDK.
11+
>
1012
> Check out the new SDK: **[together-py](https://github.com/togethercomputer/together-py)**
1113
>
1214
> 📖 **Migration Guide:** [https://docs.together.ai/docs/pythonv2-migration-guide](https://docs.together.ai/docs/pythonv2-migration-guide)
1315
>
14-
> ### Install the Beta
16+
> ### Upgrade
1517
>
1618
> **Using uv (Recommended):**
1719
> ```bash
18-
> # Install uv if you haven't already
19-
> curl -LsSf https://astral.sh/uv/install.sh | sh
20-
>
21-
> # Install together python SDK
22-
> uv add together --prerelease allow
23-
>
24-
> # Or upgrade an existing installation
25-
> uv sync --upgrade-package together --prerelease allow
20+
> uv sync --upgrade-package together
2621
> ```
2722
>
2823
> **Using pip:**
2924
> ```bash
30-
> pip install --pre together
25+
> pip install --upgrade together
3126
> ```
3227
>
33-
> This package will be maintained until January 2026.
3428
35-
# Together Python API library
29+
# Together V1
3630
3731
[![PyPI version](https://img.shields.io/pypi/v/together.svg)](https://pypi.org/project/together/)
3832
[![Discord](https://dcbadge.limes.pink/api/server/https://discord.gg/9Rk6sSeWEG?style=flat&theme=discord-inverted)](https://discord.com/invite/9Rk6sSeWEG)
3933
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/togethercompute.svg?style=social&label=Follow%20%40togethercompute)](https://twitter.com/togethercompute)
4034
35+
> 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)**
36+
4137
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.
4238
4339
4440
4541
## Installation
4642
47-
> 🚧
48-
> The Library was rewritten in v1.0.0 released in April of 2024. There were significant changes made.
49-
5043
To install Together Python Library from PyPI, simply run:
5144
5245
```shell Shell
53-
pip install --upgrade together
46+
pip install together
5447
```
5548
5649
### Setting up API Key

src/together/__init__.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@
1010
================================================================================
1111
Together Python SDK 2.0 is now available!
1212
13-
Install: pip install --pre together
13+
Install: pip install together --upgrade
14+
Install: uv sync --upgrade-package together
1415
New SDK: https://github.com/togethercomputer/together-py
1516
Migration guide: https://docs.together.ai/docs/pythonv2-migration-guide
1617
17-
This package will be maintained until January 2026.
18+
Together V1 is now deprecated and will be maintained in maintanence mode.
19+
All new features and development will occur in the 2.0 SDK.
1820
================================================================================
1921
"""
2022

@@ -28,15 +30,14 @@
2830
console.print(
2931
Panel(
3032
"[bold cyan]Together Python SDK 2.0 is now available![/bold cyan]\n\n"
31-
"Install the beta:\n"
32-
"[green]pip install --pre together[/green] or "
33-
"[green]uv add together --prerelease allow[/green]\n\n"
33+
"Upgrade to the latest version:\n"
34+
"[green]pip install together --upgrade[/green] or "
35+
"[green]uv sync --upgrade-package together[/green]\n\n"
3436
"New SDK: [link=https://github.com/togethercomputer/together-py]"
3537
"https://github.com/togethercomputer/together-py[/link]\n"
3638
"Migration guide: [link=https://docs.together.ai/docs/pythonv2-migration-guide]"
3739
"https://docs.together.ai/docs/pythonv2-migration-guide[/link]\n\n"
38-
"[dim]This package will be maintained until January 2026.\n"
39-
"Set TOGETHER_NO_BANNER=1 to hide this message.[/dim]",
40+
"[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",
4041
title="🚀 New SDK Available",
4142
border_style="cyan",
4243
)

0 commit comments

Comments
 (0)