verda 0.1.0__tar.gz → 0.2.0__tar.gz

verda-0.2.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.3
+Name: verda
+Version: 0.2.0
+Summary: Official Python SDK for Verda (formerly DataCrunch) Public API
+Author: Verda Cloud Oy
+Author-email: Verda Cloud Oy <info@verda.com>
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: requests>=2.25.1,<3
+Requires-Dist: dataclasses-json>=0.6.7
+Requires-Python: >=3.10
+Project-URL: Changelog, https://datacrunch-python.readthedocs.io/en/latest/changelog.html
+Project-URL: Documentation, https://datacrunch-python.readthedocs.io/
+Project-URL: Homepage, https://github.com/verda-cloud
+Project-URL: Repository, https://github.com/verda-cloud/sdk-python
+Description-Content-Type: text/markdown
+
+# Verda Python SDK
+
+[<img src='https://github.com/verda-cloud/sdk-python/workflows/Unit%20Tests/badge.svg'>](https://github.com/verda-cloud/sdk-python/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster)
+[<img src='https://github.com/verda-cloud/sdk-python/workflows/Code%20Style/badge.svg'>](https://github.com/verda-cloud/sdk-python/actions?query=workflow%3A%22Code+Style%22+branch%3Amaster)
+[<img src="https://codecov.io/gh/verda-cloud/sdk-python/branch/master/graph/badge.svg?token=5X5KTYSSPK">](https://codecov.io/gh/verda-cloud/sdk-python)
+[<img src='https://readthedocs.org/projects/datacrunch-python/badge/?version=latest'>](https://datacrunch-python.readthedocs.io/en/latest/)
+[<img src='https://img.shields.io/github/license/verda-cloud/sdk-python'>](https://github.com/verda-cloud/sdk-python/blob/master/LICENSE)
+[<img src='https://img.shields.io/pypi/v/verda?logo=python'>](https://pypi.org/project/verda/)
+[<img src='https://img.shields.io/pypi/pyversions/verda'>](https://pypi.org/project/verda/)
+
+The official [Verda](https://verda.com) (formerly DataCrunch) Python SDK.
+
+The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python.readthedocs.io/en/latest/)
+
+Verda Public API documentation [is available here](https://api.datacrunch.io/v1/docs).
+
+## Getting Started - Using the SDK:
+
+- Install:
+
+  ```bash
+  # via pip
+  pip3 install verda
+
+  # via uv
+  uv add verda
+  ```
+
+- Generate your client credentials - [instructions in the public API docs](https://api.datacrunch.io/v1/docs#description/quick-start-guide).
+
+
+- Add your client id and client secret to an environment variable (don't want it to be hardcoded):
+
+  Linux (bash):
+
+  ```bash
+  export VERDA_CLIENT_ID=YOUR_ID_HERE
+  export VERDA_CLIENT_SECRET=YOUR_SECRET_HERE
+  ```
+
+- To enable sending inference requests from SDK you must generate an inference key - [Instructions on inference authorization](https://docs.verda.com/inference/authorization)
+  
+
+- Add your inference key to an environment variable
+
+  Linux (bash):
+ 
+  ```bash
+  export VERDA_INFERENCE_KEY=YOUR_API_KEY_HERE
+  ```
+  
+  Other platforms:
+  https://en.wikipedia.org/wiki/Environment_variable
+
+
+
+- Example for creating a new instance:
+
+  ```python
+  import os
+  from verda import VerdaClient
+
+  # Get credentials from environment variables
+  CLIENT_ID = os.environ.get('VERDA_CLIENT_ID')
+  CLIENT_SECRET = os.environ['VERDA_CLIENT_SECRET']
+
+  # Create client
+  verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+  # Get all SSH keys
+  ssh_keys = [key.id for key in verda.ssh_keys.get()]
+
+  # Create a new instance
+  instance = verda.instances.create(instance_type='1V100.6V',
+                                    image='ubuntu-24.04-cuda-12.8-open-docker',
+                                    ssh_key_ids=ssh_keys,
+                                    hostname='example',
+                                    description='example instance')
+
+  # Delete instance
+  verda.instances.action(instance.id, verda.constants.instance_actions.DELETE)
+  ```
+
+  More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/).
+
+## Development
+
+### Set up the local development environment
+
+Prerequisite: install [`uv`](https://docs.astral.sh/uv/).
+
+Clone the repository, create local environment and install dependencies:
+
+  ```bash
+  git clone git@github.com:verda-cloud/sdk-python.git
+  cd sdk-python
+  uv sync
+  ```
+
+### Run Tests
+
+- Execute all tests
+
+  ```bash
+  uv run pytest
+  ```
+
+- Execute a single test file
+
+  ```bash
+  uv run pytest tests/unit_tests/test_file.py
+  ```
+
+### Local Manual Testing
+
+Create a file in the root directory of the project:
+
+```python
+# example.py
+from verda.verda import VerdaClient
+
+CLIENT_SECRET = 'secret'
+CLIENT_ID = 'your-id'
+
+# Create client
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1')
+```
+
+Run it:
+
+```bash
+uv run python example.py
+```
+
+### Generating the documentation
+
+If added a new service, create a documentation template under api/services for that service.
+
+```bash
+cd docs
+make html
+```
+
+### Code style
+
+```bash
+# Lint
+uv run ruff check
+
+# Format code
+uv run ruff format
+```
+
+## Contact
+
+You can [contact us here](https://verda.com/contact), or open an issue in the repo.

verda-0.2.0/README.md

@@ -0,0 +1,156 @@
+# Verda Python SDK
+
+[<img src='https://github.com/verda-cloud/sdk-python/workflows/Unit%20Tests/badge.svg'>](https://github.com/verda-cloud/sdk-python/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster)
+[<img src='https://github.com/verda-cloud/sdk-python/workflows/Code%20Style/badge.svg'>](https://github.com/verda-cloud/sdk-python/actions?query=workflow%3A%22Code+Style%22+branch%3Amaster)
+[<img src="https://codecov.io/gh/verda-cloud/sdk-python/branch/master/graph/badge.svg?token=5X5KTYSSPK">](https://codecov.io/gh/verda-cloud/sdk-python)
+[<img src='https://readthedocs.org/projects/datacrunch-python/badge/?version=latest'>](https://datacrunch-python.readthedocs.io/en/latest/)
+[<img src='https://img.shields.io/github/license/verda-cloud/sdk-python'>](https://github.com/verda-cloud/sdk-python/blob/master/LICENSE)
+[<img src='https://img.shields.io/pypi/v/verda?logo=python'>](https://pypi.org/project/verda/)
+[<img src='https://img.shields.io/pypi/pyversions/verda'>](https://pypi.org/project/verda/)
+
+The official [Verda](https://verda.com) (formerly DataCrunch) Python SDK.
+
+The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python.readthedocs.io/en/latest/)
+
+Verda Public API documentation [is available here](https://api.datacrunch.io/v1/docs).
+
+## Getting Started - Using the SDK:
+
+- Install:
+
+  ```bash
+  # via pip
+  pip3 install verda
+
+  # via uv
+  uv add verda
+  ```
+
+- Generate your client credentials - [instructions in the public API docs](https://api.datacrunch.io/v1/docs#description/quick-start-guide).
+
+
+- Add your client id and client secret to an environment variable (don't want it to be hardcoded):
+
+  Linux (bash):
+
+  ```bash
+  export VERDA_CLIENT_ID=YOUR_ID_HERE
+  export VERDA_CLIENT_SECRET=YOUR_SECRET_HERE
+  ```
+
+- To enable sending inference requests from SDK you must generate an inference key - [Instructions on inference authorization](https://docs.verda.com/inference/authorization)
+  
+
+- Add your inference key to an environment variable
+
+  Linux (bash):
+ 
+  ```bash
+  export VERDA_INFERENCE_KEY=YOUR_API_KEY_HERE
+  ```
+  
+  Other platforms:
+  https://en.wikipedia.org/wiki/Environment_variable
+
+
+
+- Example for creating a new instance:
+
+  ```python
+  import os
+  from verda import VerdaClient
+
+  # Get credentials from environment variables
+  CLIENT_ID = os.environ.get('VERDA_CLIENT_ID')
+  CLIENT_SECRET = os.environ['VERDA_CLIENT_SECRET']
+
+  # Create client
+  verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+  # Get all SSH keys
+  ssh_keys = [key.id for key in verda.ssh_keys.get()]
+
+  # Create a new instance
+  instance = verda.instances.create(instance_type='1V100.6V',
+                                    image='ubuntu-24.04-cuda-12.8-open-docker',
+                                    ssh_key_ids=ssh_keys,
+                                    hostname='example',
+                                    description='example instance')
+
+  # Delete instance
+  verda.instances.action(instance.id, verda.constants.instance_actions.DELETE)
+  ```
+
+  More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/).
+
+## Development
+
+### Set up the local development environment
+
+Prerequisite: install [`uv`](https://docs.astral.sh/uv/).
+
+Clone the repository, create local environment and install dependencies:
+
+  ```bash
+  git clone git@github.com:verda-cloud/sdk-python.git
+  cd sdk-python
+  uv sync
+  ```
+
+### Run Tests
+
+- Execute all tests
+
+  ```bash
+  uv run pytest
+  ```
+
+- Execute a single test file
+
+  ```bash
+  uv run pytest tests/unit_tests/test_file.py
+  ```
+
+### Local Manual Testing
+
+Create a file in the root directory of the project:
+
+```python
+# example.py
+from verda.verda import VerdaClient
+
+CLIENT_SECRET = 'secret'
+CLIENT_ID = 'your-id'
+
+# Create client
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1')
+```
+
+Run it:
+
+```bash
+uv run python example.py
+```
+
+### Generating the documentation
+
+If added a new service, create a documentation template under api/services for that service.
+
+```bash
+cd docs
+make html
+```
+
+### Code style
+
+```bash
+# Lint
+uv run ruff check
+
+# Format code
+uv run ruff format
+```
+
+## Contact
+
+You can [contact us here](https://verda.com/contact), or open an issue in the repo.

verda-0.2.0/pyproject.toml

@@ -0,0 +1,89 @@
+[project]
+name = "verda"
+version = "0.2.0"
+description = "Official Python SDK for Verda (formerly DataCrunch) Public API"
+readme = "README.md"
+requires-python = ">=3.10"
+
+authors = [{ name = "Verda Cloud Oy", email = "info@verda.com" }]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+dependencies = ["requests>=2.25.1,<3", "dataclasses_json>=0.6.7"]
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=2.10.1,<3",
+    "pytest-responses>=0.4.0,<1",
+    "pytest>=8.1,<9",
+    "python-dotenv>=1.1.1",
+    "responses>=0.12.1,<1",
+    "ruff>=0.14.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/verda-cloud"
+Documentation = "https://datacrunch-python.readthedocs.io/"
+Repository = "https://github.com/verda-cloud/sdk-python"
+Changelog = "https://datacrunch-python.readthedocs.io/en/latest/changelog.html"
+
+[build-system]
+requires = ["uv_build>=0.9.5,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "verda"
+module-root = ""
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+# https://docs.astral.sh/ruff/rules/
+select = [
+    # default rules, via https://docs.astral.sh/ruff/settings/#lint_extend-select
+    "E4", "E7", "E9", "F",
+    # comprehensions
+    "C4",
+    # sort imports
+    "I",
+    # pytest
+    "PT",
+    # bugbear
+    "B",
+    # upgrade to new python syntax
+    "UP",
+    # pydocstyle
+    "D",
+    # builtins
+    "A",
+    # unused args
+    "ARG",
+    # Ruff
+    "RUF",
+]
+flake8-builtins.ignorelist = ["id", "type"]
+pydocstyle.convention = "google"
+
+# TODO(shamrin) stop ignoring these errors
+ignore = ["F401", "B006", "D100", "D105", "D107"]
+
+[tool.ruff.lint.per-file-ignores]
+"{tests,examples}/*" = ["D"]
+"__init__.py" = ["D104"]
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-format = true

verda-0.2.0/verda/InferenceClient/__init__.py

@@ -0,0 +1,3 @@
+from .inference_client import InferenceClient, InferenceResponse
+
+__all__ = ['InferenceClient', 'InferenceResponse']