Skip to content

Commit 2650576

Browse files
committed
Add more info to README
1 parent 11c0060 commit 2650576

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
# Pinecone Python Client (DEPRECATED)
22

3-
The official Pinecone python package has been renamed from `pinecone-client` to `pinecone`. Please remove `pinecone-client` from your project dependencies and add the `pinecone` package to get the latest updates.
3+
The official Pinecone python package has been renamed from `pinecone-client` to `pinecone`. To upgrade, please
4+
**remove** `pinecone-client` from your project dependencies and then **add** the `pinecone` package to get the
5+
latest updates.
6+
7+
> [!WARNING]
8+
> Failure to remove `pinecone-client` before installing `pinecone` can lead to confusing interactions
9+
> between the two packages.
10+
11+
```sh
12+
pip uninstall pinecone-client
13+
pip install pinecone
14+
```
15+
16+
Or, if you are using grpc:
17+
18+
```sh
19+
pip uninstall pinecone-client
20+
pip install "pinecone[grpc]"
21+
```
22+
23+
## Links
424

525
- `pinecone` on [PyPI](https://pypi.org/project/pinecone/)
626
- [Source on Github](https://github.com/pinecone-io/pinecone-python-client)

0 commit comments

Comments
 (0)