vellum-ai 0.7.11__tar.gz → 0.8.4__tar.gz

vellum_ai-0.8.4/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.1
+Name: vellum-ai
+Version: 0.8.4
+Summary: 
+License: MIT
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: cdktf (>=0.20.5,<0.21.0)
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: publication (==0.0.3)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Vellum Python Library
+
+[![pypi](https://img.shields.io/pypi/v/vellum-ai.svg)](https://pypi.python.org/pypi/vellum-ai)
+![license badge](https://img.shields.io/github/license/vellum-ai/vellum-client-python)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-python/readme)
+
+The Vellum Python SDK provides access to the Vellum API from python.
+
+
+## API Docs
+You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+## Installation
+
+```sh
+pip install --upgrade vellum-ai
+```
+
+## Usage
+Below is how you would invoke a deployed Prompt from the Vellum API. For a complete list of all APIs
+that Vellum supports, check out our [API Reference](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+```python
+from vellum import (
+    StringInputRequest,
+)
+from vellum.client import Vellum
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+
+def execute() -> str:
+    result = client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            StringInputRequest(
+                name="input_a",
+                type="STRING",
+                value="Hello, world!",
+            )
+        ],
+    )
+    
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(execute())
+```
+
+> [!TIP]
+> You can set a system environment variable `VELLUM_API_KEY` to avoid writing your api key within your code. To do so, add `export VELLUM_API_KEY=<your-api-token>`
+> to your ~/.zshrc or ~/.bashrc, open a new terminal, and then any code calling `vellum.Vellum()` will read this key.
+
+## Async Client
+This SDK has an async version. Here's how to use it:
+
+
+
+```python
+import asyncio
+
+import vellum
+from vellum.client import AsyncVellum
+
+client = AsyncVellum(api_key="YOUR_API_KEY")
+
+async def execute() -> str:
+    result = await client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            vellum.StringInputRequest(
+                name="input_a",
+                value="Hello, world!",
+            )
+        ],
+    )
+
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+    
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(asyncio.run(execute()))
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, most of this library is generated programmatically.
+
+Please feel free to make contributions to any of the directories or files below:
+```plaintext
+examples/*
+src/vellum/lib/*
+tests/*
+README.md
+```
+
+Any additions made to files beyond those directories and files above would have to be moved over to our generation code
+(found in the separate [vellum-client-generator](https://github.com/vellum-ai/vellum-client-generator) repo),
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept,
+but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
+

vellum_ai-0.8.4/README.md

@@ -0,0 +1,108 @@
+# Vellum Python Library
+
+[![pypi](https://img.shields.io/pypi/v/vellum-ai.svg)](https://pypi.python.org/pypi/vellum-ai)
+![license badge](https://img.shields.io/github/license/vellum-ai/vellum-client-python)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-python/readme)
+
+The Vellum Python SDK provides access to the Vellum API from python.
+
+
+## API Docs
+You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+## Installation
+
+```sh
+pip install --upgrade vellum-ai
+```
+
+## Usage
+Below is how you would invoke a deployed Prompt from the Vellum API. For a complete list of all APIs
+that Vellum supports, check out our [API Reference](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+```python
+from vellum import (
+    StringInputRequest,
+)
+from vellum.client import Vellum
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+
+def execute() -> str:
+    result = client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            StringInputRequest(
+                name="input_a",
+                type="STRING",
+                value="Hello, world!",
+            )
+        ],
+    )
+    
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(execute())
+```
+
+> [!TIP]
+> You can set a system environment variable `VELLUM_API_KEY` to avoid writing your api key within your code. To do so, add `export VELLUM_API_KEY=<your-api-token>`
+> to your ~/.zshrc or ~/.bashrc, open a new terminal, and then any code calling `vellum.Vellum()` will read this key.
+
+## Async Client
+This SDK has an async version. Here's how to use it:
+
+
+
+```python
+import asyncio
+
+import vellum
+from vellum.client import AsyncVellum
+
+client = AsyncVellum(api_key="YOUR_API_KEY")
+
+async def execute() -> str:
+    result = await client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            vellum.StringInputRequest(
+                name="input_a",
+                value="Hello, world!",
+            )
+        ],
+    )
+
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+    
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(asyncio.run(execute()))
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, most of this library is generated programmatically.
+
+Please feel free to make contributions to any of the directories or files below:
+```plaintext
+examples/*
+src/vellum/lib/*
+tests/*
+README.md
+```
+
+Any additions made to files beyond those directories and files above would have to be moved over to our generation code
+(found in the separate [vellum-client-generator](https://github.com/vellum-ai/vellum-client-generator) repo),
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept,
+but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

vellum_ai-0.8.4/pyproject.toml

@@ -0,0 +1,64 @@
+[tool.poetry]
+name = "vellum-ai"
+version = "0.8.4"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+license = "MIT"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+    "License :: OSI Approved :: MIT License"
+]
+packages = [
+    { include = "vellum", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/vellum-ai/vellum-client-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+cdktf = "^0.20.5"
+httpx = ">=0.21.2"
+publication = "0.0.3"
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "^0.5.6"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"