Skip to content

Commit

Permalink
Rename package from pinecone-client to pinecone (#383)
Browse files Browse the repository at this point in the history
## 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.
  • Loading branch information
jhamon authored Aug 16, 2024
1 parent f1fb433 commit 3d20906
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 91 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/alpha-release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'PyPI Release: Pre-Release (pinecone-client)'
name: 'PyPI Release: Pre-Release (pinecone)'

on:
workflow_dispatch:
Expand Down
73 changes: 0 additions & 73 deletions .github/workflows/nightly-release.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'PyPI Release: Production (pinecone-client)'
name: 'PyPI Release: Production (pinecone)'

on:
workflow_dispatch:
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,40 +33,40 @@ The Pinecone Python SDK is compatible with Python 3.8 and greater.

## Installation

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.
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.

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).

### Installing with pip

```shell
# Install the latest version
pip3 install pinecone-client
pip3 install pinecone

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

# Install a specific version
pip3 install pinecone-client==5.0.0
pip3 install pinecone==5.0.0

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

### Installing with poetry

```shell
# Install the latest version
poetry add pinecone-client
poetry add pinecone

# Install the latest version, with grpc extras
poetry add pinecone-client --extras grpc
poetry add pinecone --extras grpc

# Install a specific version
poetry add pinecone-client==5.0.0
poetry add pinecone==5.0.0

# Install a specific version, with grpc extras
poetry add pinecone-client==5.0.0 --extras grpc
poetry add pinecone==5.0.0 --extras grpc
```

## Usage
Expand Down
8 changes: 4 additions & 4 deletions pinecone/grpc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@
```bash
# Install the latest version
pip3 install pinecone-client[grpc]
pip3 install pinecone[grpc]
# Install a specific version
pip3 install "pinecone-client[grpc]"==3.0.0
pip3 install "pinecone[grpc]"==3.0.0
```
#### Installing with poetry
```bash
# Install the latest version
poetry add pinecone-client --extras grpc
poetry add pinecone --extras grpc
# Install a specific version
poetry add pinecone-client==3.0.0 --extras grpc
poetry add pinecone==3.0.0 --extras grpc
```
### Using the gRPC client
Expand Down
4 changes: 2 additions & 2 deletions pinecone/grpc/pinecone.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class PineconeGRPC(Pinecone):
pip3 install pinecone[grpc]
# Install a specific version
pip3 install "pinecone-client[grpc]"==3.0.0
pip3 install "pinecone[grpc]"==3.0.0
```
#### Installing with poetry
Expand All @@ -29,7 +29,7 @@ class PineconeGRPC(Pinecone):
poetry add pinecone --extras grpc
# Install a specific version
poetry add pinecone-client==3.0.0 --extras grpc
poetry add pinecone==3.0.0 --extras grpc
```
### Using the gRPC client
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ exclude = '''
'''

[tool.poetry]
name = "pinecone-client"
name = "pinecone"
version = "5.0.1"
packages = [
{ include="pinecone", from="." },
Expand Down

0 comments on commit 3d20906

Please sign in to comment.