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

[ENH] Cloud client #1462

Merged
merged 10 commits into from
Dec 8, 2023
Merged

[ENH] Cloud client #1462

merged 10 commits into from
Dec 8, 2023

Conversation

atroyn
Copy link
Contributor

@atroyn atroyn commented Dec 5, 2023

Description of changes

This PR adds the Chroma CloudClient as a client type. It takes an API key (or reads it from the environment, or prompts the user for it if it's not found) , and tries to connect to the Chroma cloud using the API key.

Under the hood, this is a specialized HTTPClient with ssl always turned on, and which uses token-based authentication with the API key as the token.

This PR also moves the AuthorizationError from auth to the general set of errors, so it can be handled elsewhere by the Chroma system.

Test plan

Added a new test, test_cloud_client, which creates a mock 'cloud' server and then tests connection with valid and invalid API keys.

Documentation Changes

Cloud is not yet available, so CloudClient is for now not to be used by external users of Chroma. Therefore, we won't land documentation changes with this PR.

TODOs

Copy link

github-actions bot commented Dec 5, 2023

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readbility, Modularity, Intuitiveness)

chromadb/__init__.py Outdated Show resolved Hide resolved
chromadb/__init__.py Outdated Show resolved Hide resolved
chromadb/__init__.py Show resolved Hide resolved
chromadb/__init__.py Show resolved Hide resolved
chromadb/__init__.py Outdated Show resolved Hide resolved
@atroyn atroyn marked this pull request as ready for review December 8, 2023 09:04
@atroyn atroyn changed the title [DRAFT][ENH] Cloud client [ENH] Cloud client Dec 8, 2023
Copy link
Member

@beggers beggers left a comment

Choose a reason for hiding this comment

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

🚀

chromadb/__init__.py Show resolved Hide resolved
chromadb/__init__.py Show resolved Hide resolved
@atroyn atroyn merged commit 4ae47cd into main Dec 8, 2023
95 checks passed
@atroyn atroyn deleted the anton/cloud-client branch December 8, 2023 21:14
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.

None yet

2 participants