Skip to content

Commit 3d20906

Browse files
authored
Rename package from pinecone-client to pinecone (#383)
## Problem We want to rename this package from `pinecone-client` to `pinecone`. ## Solution - Update `pyproject.toml` to refer to the new name `pinecone` - Find and replace references to old package name in README and docstrings - Remove nightly publish job that would need to be updated but has been broken for a long time for other reasons After this rename, we will need to setup a separate project to wrap this and continue publishing it under the old `pinecone-client` name for people who may not know about the rename, very similar to how old releases have been republished as `pinecone` using [this wrapper project](https://github.com/pinecone-io/pypi-backfill-pinecone). ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [ ] Non-code change (docs, etc) - [x] None of the above: We plan to publish a wrapper package under the name `pinecone-client`. So this shouldn't be a breaking change for end users consuming updates via the old name. ## Test Plan Describe specific steps for validating this change.
1 parent f1fb433 commit 3d20906

File tree

7 files changed

+18
-91
lines changed

7 files changed

+18
-91
lines changed

.github/workflows/alpha-release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'PyPI Release: Pre-Release (pinecone-client)'
1+
name: 'PyPI Release: Pre-Release (pinecone)'
22

33
on:
44
workflow_dispatch:

.github/workflows/nightly-release.yaml

Lines changed: 0 additions & 73 deletions
This file was deleted.

.github/workflows/release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'PyPI Release: Production (pinecone-client)'
1+
name: 'PyPI Release: Production (pinecone)'
22

33
on:
44
workflow_dispatch:

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,40 +33,40 @@ The Pinecone Python SDK is compatible with Python 3.8 and greater.
3333

3434
## Installation
3535

36-
There are two flavors of the Pinecone Python SDK. The default flavor installed from PyPI as `pinecone-client` has a minimal set of dependencies and interacts with Pinecone via HTTP requests.
36+
There are two flavors of the Pinecone Python SDK. The default flavor installed from PyPI as `pinecone` has a minimal set of dependencies and interacts with Pinecone via HTTP requests.
3737

3838
If you are aiming to maximimize performance, you can install additional gRPC dependencies to access an alternate SDK implementation that relies on gRPC for data operations. See the guide on [tuning performance](https://docs.pinecone.io/docs/performance-tuning).
3939

4040
### Installing with pip
4141

4242
```shell
4343
# Install the latest version
44-
pip3 install pinecone-client
44+
pip3 install pinecone
4545

4646
# Install the latest version, with extra grpc dependencies
47-
pip3 install "pinecone-client[grpc]"
47+
pip3 install "pinecone[grpc]"
4848

4949
# Install a specific version
50-
pip3 install pinecone-client==5.0.0
50+
pip3 install pinecone==5.0.0
5151

5252
# Install a specific version, with grpc extras
53-
pip3 install "pinecone-client[grpc]"==5.0.0
53+
pip3 install "pinecone[grpc]"==5.0.0
5454
```
5555

5656
### Installing with poetry
5757

5858
```shell
5959
# Install the latest version
60-
poetry add pinecone-client
60+
poetry add pinecone
6161

6262
# Install the latest version, with grpc extras
63-
poetry add pinecone-client --extras grpc
63+
poetry add pinecone --extras grpc
6464

6565
# Install a specific version
66-
poetry add pinecone-client==5.0.0
66+
poetry add pinecone==5.0.0
6767

6868
# Install a specific version, with grpc extras
69-
poetry add pinecone-client==5.0.0 --extras grpc
69+
poetry add pinecone==5.0.0 --extras grpc
7070
```
7171

7272
## Usage

pinecone/grpc/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@
1313
1414
```bash
1515
# Install the latest version
16-
pip3 install pinecone-client[grpc]
16+
pip3 install pinecone[grpc]
1717
1818
# Install a specific version
19-
pip3 install "pinecone-client[grpc]"==3.0.0
19+
pip3 install "pinecone[grpc]"==3.0.0
2020
```
2121
2222
#### Installing with poetry
2323
2424
```bash
2525
# Install the latest version
26-
poetry add pinecone-client --extras grpc
26+
poetry add pinecone --extras grpc
2727
2828
# Install a specific version
29-
poetry add pinecone-client==3.0.0 --extras grpc
29+
poetry add pinecone==3.0.0 --extras grpc
3030
```
3131
3232
### Using the gRPC client

pinecone/grpc/pinecone.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class PineconeGRPC(Pinecone):
1919
pip3 install pinecone[grpc]
2020
2121
# Install a specific version
22-
pip3 install "pinecone-client[grpc]"==3.0.0
22+
pip3 install "pinecone[grpc]"==3.0.0
2323
```
2424
2525
#### Installing with poetry
@@ -29,7 +29,7 @@ class PineconeGRPC(Pinecone):
2929
poetry add pinecone --extras grpc
3030
3131
# Install a specific version
32-
poetry add pinecone-client==3.0.0 --extras grpc
32+
poetry add pinecone==3.0.0 --extras grpc
3333
```
3434
3535
### Using the gRPC client

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ exclude = '''
1515
'''
1616

1717
[tool.poetry]
18-
name = "pinecone-client"
18+
name = "pinecone"
1919
version = "5.0.1"
2020
packages = [
2121
{ include="pinecone", from="." },

0 commit comments

Comments
 (0)