orvanta 1.0.2__tar.gz

orvanta-1.0.2/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: orvanta
+Version: 1.0.2
+Summary: A client library for accessing Orvanta server wrapping the Orvanta client API
+License: Apache-2.0
+Author: Ivo Pauly-Koelewijn
+Author-email: ivo@codegarden.nl
+Requires-Python: >=3.7,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpx (>=0.24)
+Project-URL: Documentation, https://orvanta.ai
+Project-URL: Homepage, https://orvanta.ai
+Description-Content-Type: text/markdown
+
+# orvanta
+
+The core client for the [Orvanta](https://orvanta.ai) platform.
+
+
+## Usage
+
+### Basic Usage
+
+The `orvanta` package has several methods at the top-level for the most frequent operations you will need.
+
+The following are some common examples:
+
+```python
+import time
+
+import orvanta
+
+
+def main():
+    # Get the value of a variable
+    orvanta.get_variable("u/user/variable_path")
+    
+    # Run a script synchronously and get the result
+    orvanta.run_script("f/pathto/script", args={"arg1": "value1"})
+    
+    # Get the value of a resource
+    orvanta.get_resource("u/user/resource_path")
+    
+    # Set the script's state
+    orvanta.set_state({"ts": time.time()})
+    
+    # Get the script's state
+    orvanta.get_state()
+```
+
+### Advanced Usage
+
+The `orvanta` package also exposes the `Orvanta` class, which is the core client for the Orvanta platform.
+
+```python
+import time
+
+from orvanta import Orvanta
+
+def main():
+    client = Orvanta(
+        # token=...  <- this is optional. otherwise the client will look for the OV_TOKEN env var
+    )
+
+    # Get the current version of the client
+    client.version
+
+    # Get the current user
+    client.user
+    
+    # Convenience get and post methods exist for https://orvanta.cloud/openapi.html#/
+    # these are thin wrappers around the httpx library's get and post methods
+    # list worker groups
+    client.get("/configs/list_worker_groups")
+    # create a group
+    client.post(
+        f"/w/{client.workspace}/groups/create",
+        json={
+            "name": "my-group",
+            "summary": "my group summary",
+        }
+    )
+    
+    # Get and set the state of the script
+    now = time.time()
+    client.state = {"ts": now}
+    assert client.state == {"ts": now}
+    
+    # Run a job asynchronously
+    job_id = client.run_script_async(path="path/to/script")
+    # Get its status
+    client.get_job_status(job_id)
+    # Get its result
+    client.get_result(job_id)
+
+
+```
+

orvanta-1.0.2/README.md

@@ -0,0 +1,83 @@
+# orvanta
+
+The core client for the [Orvanta](https://orvanta.ai) platform.
+
+
+## Usage
+
+### Basic Usage
+
+The `orvanta` package has several methods at the top-level for the most frequent operations you will need.
+
+The following are some common examples:
+
+```python
+import time
+
+import orvanta
+
+
+def main():
+    # Get the value of a variable
+    orvanta.get_variable("u/user/variable_path")
+    
+    # Run a script synchronously and get the result
+    orvanta.run_script("f/pathto/script", args={"arg1": "value1"})
+    
+    # Get the value of a resource
+    orvanta.get_resource("u/user/resource_path")
+    
+    # Set the script's state
+    orvanta.set_state({"ts": time.time()})
+    
+    # Get the script's state
+    orvanta.get_state()
+```
+
+### Advanced Usage
+
+The `orvanta` package also exposes the `Orvanta` class, which is the core client for the Orvanta platform.
+
+```python
+import time
+
+from orvanta import Orvanta
+
+def main():
+    client = Orvanta(
+        # token=...  <- this is optional. otherwise the client will look for the OV_TOKEN env var
+    )
+
+    # Get the current version of the client
+    client.version
+
+    # Get the current user
+    client.user
+    
+    # Convenience get and post methods exist for https://orvanta.cloud/openapi.html#/
+    # these are thin wrappers around the httpx library's get and post methods
+    # list worker groups
+    client.get("/configs/list_worker_groups")
+    # create a group
+    client.post(
+        f"/w/{client.workspace}/groups/create",
+        json={
+            "name": "my-group",
+            "summary": "my group summary",
+        }
+    )
+    
+    # Get and set the state of the script
+    now = time.time()
+    client.state = {"ts": now}
+    assert client.state == {"ts": now}
+    
+    # Run a job asynchronously
+    job_id = client.run_script_async(path="path/to/script")
+    # Get its status
+    client.get_job_status(job_id)
+    # Get its result
+    client.get_result(job_id)
+
+
+```

orvanta-1.0.2/orvanta/__init__.py

@@ -0,0 +1,2 @@
+from .client import *
+from .s3_types import *