QuotientAI SDK v0.1.0 (#54)

Author: freddiev4

.env.test

@@ -163,3 +163,5 @@ cython_debug/
 .DS_Store
 
 .ruff_cache
+
+.vscode/

.gitignore

@@ -1,10 +1,53 @@
-# quotientai Python Client
+# quotientai
+[![PyPI version](https://img.shields.io/pypi/v/quotientai)](https://pypi.org/project/quotientai)
 
 ## Overview
 
-`quotientai` is an SDK and CLI built to manage your workflows on Quotient AI, the AI Evaluation Company.
+`quotientai` is an SDK and CLI built to manage artifacts (prompts, datasets), and run evaluations on [Quotient](https://quotientai.co).
 
-We are currently in closed beta. For more information on how to get early access visit us at [QuotientAI.co](https://www.quotientai.co/)
+## Installation
 
-## Support
-For assistance and inquiries: [[email protected]](mailto:[email protected])
+```console
+pip install quotientai
+```
+
+## Usage
+
+Create an API key on Quotient and set it as an environment variable called `QUOTIENT_API_KEY`. Then follow the examples below or see our [docs](https://docs.quotientai.co) for a more comprehensive walkthrough.
+
+### Examples
+
+**Create a prompt:**
+
+```python
+from quotientai import QuotientAI
+
+quotient = QuotientAI()
+
+new_prompt = quotient.prompts.create(
+    name="customer-support-inquiry"
+    system_prompt="You are a helpful assistant.",
+    user_prompt="How can I assist you today?"
+)
+
+print(new_prompt)
+```
+
+**Create a dataset:**
+
+```python
+from quotientai import QuotientAI
+
+quotient = QuotientAI()
+
+new_dataset = quotient.datasets.create(
+    name="my-sample-dataset"
+    description="My first dataset",
+    rows=[
+        {"input": "Sample input", "expected": "Sample output"},
+        {"input": "Another input", "expected": "Another output"}
+    ]
+)
+
+print(new_dataset)
+```

.vscode/settings.json

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "quotientai"
-version = "0.0.7"
+version = "0.1.0"
 authors = [
     "Vic Weiss <[email protected]>",
     "Freddie Vargus <[email protected]>",
@@ -20,12 +20,7 @@ python = "^3.9"
 typer = "^0.9.0"
 rich = "^13.7.0"
 click = "^8.1.7"
-prettytable = "^3.9.0"
-requests = "^2.31.0"
-numpy = "^1.26.4"
-python-dotenv = "^1.0.1"
-pandas = "^1.5.3"
-postgrest = "^0.16.2"
+httpx = "^0.27.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.0"
@@ -37,4 +32,4 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
-quotient = "quotientai.cli.entrypoint:cli"
+quotient = "quotientai.cli.entrypoint:app"

README.md

@@ -1,13 +1,7 @@
-from .client import QuotientClient
-from .exceptions import (
-    QuotientAIAuthException,
-    QuotientAIException,
-    QuotientAIInvalidInputException,
-)
+from .client import QuotientAI
+from .exceptions import QuotientAIError
 
 __all__ = [
-    "QuotientClient",
-    "QuotientAIException",
-    "QuotientAIAuthException",
-    "QuotientAIInvalidInputException",
+    "QuotientAI",
+    "QuotientAIError",
 ]

dev/README.md

@@ -1,3 +1,3 @@
-from .entrypoint import cli
+from .entrypoint import app
 
-__all__ = ["cli"]
+__all__ = ["app"]