diff --git a/.github/workflows/alpha-release.yaml b/.github/workflows/alpha-release.yaml index dfb84929..498c9a3e 100644 --- a/.github/workflows/alpha-release.yaml +++ b/.github/workflows/alpha-release.yaml @@ -1,4 +1,4 @@ -name: 'PyPI Release: Pre-Release (pinecone-client)' +name: 'PyPI Release: Pre-Release (pinecone)' on: workflow_dispatch: diff --git a/.github/workflows/nightly-release.yaml b/.github/workflows/nightly-release.yaml deleted file mode 100644 index ec0f6bd2..00000000 --- a/.github/workflows/nightly-release.yaml +++ /dev/null @@ -1,73 +0,0 @@ -name: 'PyPI Release: Nightly (pinecone-client-nightly)' - -on: - workflow_dispatch: - schedule: - - cron: '0 0 * * *' - -jobs: - unit-tests: - uses: './.github/workflows/testing-unit.yaml' - secrets: inherit - integration-tests: - uses: './.github/workflows/testing-integration.yaml' - secrets: inherit - dependency-tests: - uses: './.github/workflows/testing-dependency.yaml' - secrets: inherit - - pypi-nightly: - needs: - - unit-tests - - integration-tests - - dependency-tests - timeout-minutes: 30 - name: pypi-nightly - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Get recent changes - id: list-commits - run: | - recentCommits=$(git log --since=yesterday --oneline) - echo "commits=$recentCommits" >> "$GITHUB_OUTPUT" - - - name: Abort if no recent changes - if: steps.list-commits.outputs.commits == '' - uses: andymckay/cancel-action@0.3 - - - uses: actions/setup-python@v5 - with: - python-version: 3.x - - - name: Setup Poetry - uses: ./.github/actions/setup-poetry - - - name: Set dev version - id: version - run: | - currentDate=$(date +%Y%m%d%H%M%S) - versionNumber=$(poetry version -s) - devVersion="${versionNumber}.dev${currentDate}" - poetry version $devVersion - - - name: Adjust module name - run: | - sed -i 's/pinecone-client/pinecone-client-nightly/g' pyproject.toml - - - name: Update README - run: | - echo "This is a nightly developer build of the Pinecone Python client. It is not intended for production use." > README.md - - - name: Build Python client - run: make package - - - name: Upload Python client to PyPI - id: pypi_upload - env: - TWINE_REPOSITORY: pypi - PYPI_USERNAME: __token__ - PYPI_PASSWORD: ${{ secrets.PROD_PYPI_PUBLISH_TOKEN }} - run: make upload diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index f9ad4ba1..6889c484 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,4 +1,4 @@ -name: 'PyPI Release: Production (pinecone-client)' +name: 'PyPI Release: Production (pinecone)' on: workflow_dispatch: diff --git a/README.md b/README.md index 2fec0dca..b259d1e8 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ 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). @@ -41,32 +41,32 @@ If you are aiming to maximimize performance, you can install additional gRPC dep ```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 diff --git a/pinecone/grpc/__init__.py b/pinecone/grpc/__init__.py index 19b92afa..bc0a40a0 100644 --- a/pinecone/grpc/__init__.py +++ b/pinecone/grpc/__init__.py @@ -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 diff --git a/pinecone/grpc/pinecone.py b/pinecone/grpc/pinecone.py index 830f6eab..af6a8baa 100644 --- a/pinecone/grpc/pinecone.py +++ b/pinecone/grpc/pinecone.py @@ -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 @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 53faba4b..53c25553 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ exclude = ''' ''' [tool.poetry] -name = "pinecone-client" +name = "pinecone" version = "5.0.1" packages = [ { include="pinecone", from="." },