Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename package from pinecone-client to pinecone #383

Merged
merged 2 commits into from
Aug 16, 2024
Merged

Conversation

jhamon
Copy link
Collaborator

@jhamon jhamon commented Aug 12, 2024

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.

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)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • 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.

@jhamon jhamon marked this pull request as ready for review August 15, 2024 17:43
Copy link
Contributor

@rohanshah18 rohanshah18 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for renaming the package?

Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks again for getting this over the line.

@jhamon
Copy link
Collaborator Author

jhamon commented Aug 15, 2024

What's the reason for renaming the package?

We went through a long process this year to get control of the package name pinecone which was previously being squatted by an inactive project. Pinecone is our trademark, so makes sense that we should have the name since it wasn't really being used. Now we have to do some work to migrate over everything (docs, etc) but don't want to break compatibility with anything else out there referencing the old name.

@jhamon jhamon merged commit 3d20906 into main Aug 16, 2024
85 checks passed
@jhamon jhamon deleted the jhamon/rename-pinecone branch August 16, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants