Skip to content

Commit

Permalink
Add contribution guideline and README (#4)
Browse files Browse the repository at this point in the history
* Add contribution guideline and README

* Drop docker mention from README

* Update README.md

Co-authored-by: Connor Clark <[email protected]>
Signed-off-by: benrules3 <[email protected]>

---------

Signed-off-by: benrules3 <[email protected]>
Co-authored-by: Connor Clark <[email protected]>
  • Loading branch information
benrules3 and crclark-cohere authored Jun 24, 2024
1 parent 9bf1288 commit 696bf1f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# OSS Toolkit Contributing Guide

Thank you for your interest in contributing to Cohere's Compass SDK. This guide will help explain the contribution workflow from opening an issue, creating a PR, to reviewing and merging your added changes.

## How to Contribute

1. Ensure your change has an issue! Find an existing issue or open a new issue.
- This is where you can get a feel if the change will be accepted or not.
2. Once approved, fork this repository in your own GitHub account.
3. [Fork this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
4. Make your changes on your fork and make sure all your [commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)!
5. [Submit the fork as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch this repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Cohere Compass SDK

WIP
The Compass SDK is a Python library that allows you to parse documents and insert them into a Compass index.

In order to parse documents, the Compass SDK relies on the Compass Parser API, which is a RESTful API that
receives files and returns parsed documents. This requires a hosted Compass server.

The Compass SDK provides a `CompassParserClient` that allows to interact with the parser API from your
Python code in a convenient manner. The `CompassParserClient` provides methods to parse single and multiple
files, as well as entire folders, and supports multiple file types (e.g., `pdf`, `docx`, `json`, `csv`, etc.) as well
as different file systems (e.g., local, S3, GCS, etc.).

To insert parsed documents into a `Compass` index, the Compass SDK provides a `CompassClient` class that
allows to interact with a Compass API server. The Compass API is also a RESTful API that allows to create,
delete and search documents in a Compass index. To install a Compass API service, please refer to the
[Compass documentation](https://github.com/cohere-ai/compass)

0 comments on commit 696bf1f

Please sign in to comment.