verda 0.1.0__py3-none-any.whl → 1.17.0__py3-none-any.whl

verda/volumes/volumes.py

@@ -0,0 +1,386 @@
+from verda.constants import Locations, VolumeActions
+from verda.helpers import stringify_class_object_properties
+
+VOLUMES_ENDPOINT = '/volumes'
+
+
+class Volume:
+    """A volume model class."""
+
+    def __init__(
+        self,
+        id: str,
+        status: str,
+        name: str,
+        size: int,
+        type: str,
+        is_os_volume: bool,
+        created_at: str,
+        target: str | None = None,
+        location: str = Locations.FIN_03,
+        instance_id: str | None = None,
+        ssh_key_ids: list[str] = [],
+        deleted_at: str | None = None,
+    ) -> None:
+        """Initialize the volume object.
+
+        :param id: volume id
+        :type id: str
+        :param status: volume status
+        :type status: str
+        :param name: volume name
+        :type name: str
+        :param size: volume size in GB
+        :type size: int
+        :param type: volume type
+        :type type: str
+        :param is_os_volume: indication whether this is an operating systen volume
+        :type is_os_volume: bool
+        :param created_at: the time the volume was created (UTC)
+        :type created_at: str
+        :param target: target device e.g. vda
+        :type target: str, optional
+        :param location: datacenter location, defaults to "FIN-03"
+        :type location: str, optional
+        :param instance_id: the instance id the volume is attached to, None if detached
+        :type instance_id: str
+        :param ssh_key_ids: list of ssh keys ids
+        :type ssh_key_ids: list[str]
+        :param deleted_at: the time the volume was deleted (UTC), defaults to None
+        :type deleted_at: str, optional
+        """
+        self._id = id
+        self._status = status
+        self._name = name
+        self._size = size
+        self._type = type
+        self._is_os_volume = is_os_volume
+        self._created_at = created_at
+        self._target = target
+        self._location = location
+        self._instance_id = instance_id
+        self._ssh_key_ids = ssh_key_ids
+        self._deleted_at = deleted_at
+
+    @property
+    def id(self) -> str:
+        """Get the volume id.
+
+        :return: volume id
+        :rtype: str
+        """
+        return self._id
+
+    @property
+    def status(self) -> str:
+        """Get the volume status.
+
+        :return: volume status
+        :rtype: str
+        """
+        return self._status
+
+    @property
+    def name(self) -> str:
+        """Get the volume name.
+
+        :return: volume name
+        :rtype: str
+        """
+        return self._name
+
+    @property
+    def size(self) -> int:
+        """Get the volume size.
+
+        :return: volume size
+        :rtype: int
+        """
+        return self._size
+
+    @property
+    def type(self) -> int:
+        """Get the volume type.
+
+        :return: volume type
+        :rtype: string
+        """
+        return self._type
+
+    @property
+    def is_os_volume(self) -> bool:
+        """Return true iff the volume contains an operating system.
+
+        :return: true iff the volume contains an OS
+        :rtype: bool
+        """
+        return self._is_os_volume
+
+    @property
+    def created_at(self) -> str:
+        """Get the time when the volume was created (UTC).
+
+        :return: time
+        :rtype: str
+        """
+        return self._created_at
+
+    @property
+    def target(self) -> str | None:
+        """Get the target device.
+
+        :return: target device
+        :rtype: str, optional
+        """
+        return self._target
+
+    @property
+    def location(self) -> str:
+        """Get the volume datacenter location.
+
+        :return: datacenter location
+        :rtype: str
+        """
+        return self._location
+
+    @property
+    def instance_id(self) -> str | None:
+        """Get the instance id the volume is attached to, if attached. Otherwise None.
+
+        :return: instance id if attached, None otherwise
+        :rtype: str, optional
+        """
+        return self._instance_id
+
+    @property
+    def ssh_key_ids(self) -> list[str]:
+        """Get the SSH key IDs of the instance.
+
+        :return: SSH key IDs
+        :rtype: list[str]
+        """
+        return self._ssh_key_ids
+
+    @property
+    def deleted_at(self) -> str | None:
+        """Get the time when the volume was deleted (UTC).
+
+        :return: time
+        :rtype: str
+        """
+        return self._deleted_at
+
+    @classmethod
+    def create_from_dict(cls: 'Volume', volume_dict: dict) -> 'Volume':
+        """Create a Volume object from a dictionary.
+
+        :param volume_dict: dictionary representing the volume
+        :type volume_dict: dict
+        :return: Volume
+        :rtype: Volume
+        """
+        return cls(
+            id=volume_dict['id'],
+            status=volume_dict['status'],
+            name=volume_dict['name'],
+            size=volume_dict['size'],
+            type=volume_dict['type'],
+            is_os_volume=volume_dict['is_os_volume'],
+            created_at=volume_dict['created_at'],
+            target=volume_dict['target'],
+            location=volume_dict['location'],
+            instance_id=volume_dict['instance_id'],
+            ssh_key_ids=volume_dict['ssh_key_ids'],
+            deleted_at=volume_dict.get('deleted_at'),
+        )
+
+    def __str__(self) -> str:
+        """Returns a string of the json representation of the volume.
+
+        :return: json representation of the volume
+        :rtype: str
+        """
+        return stringify_class_object_properties(self)
+
+
+class VolumesService:
+    """A service for interacting with the volumes endpoint."""
+
+    def __init__(self, http_client) -> None:
+        self._http_client = http_client
+
+    def get(self, status: str | None = None) -> list[Volume]:
+        """Get all of the client's non-deleted volumes, or volumes with specific status.
+
+        :param status: optional, status of the volumes, defaults to None
+        :type status: str, optional
+        :return: list of volume details objects
+        :rtype: list[Volume]
+        """
+        volumes_dict = self._http_client.get(VOLUMES_ENDPOINT, params={'status': status}).json()
+        return list(map(Volume.create_from_dict, volumes_dict))
+
+    def get_by_id(self, id: str) -> Volume:
+        """Get a specific volume by its.
+
+        :param id: volume id
+        :type id: str
+        :return: Volume details object
+        :rtype: Volume
+        """
+        volume_dict = self._http_client.get(VOLUMES_ENDPOINT + f'/{id}').json()
+
+        return Volume.create_from_dict(volume_dict)
+
+    def get_in_trash(self) -> list[Volume]:
+        """Get all volumes that are in trash.
+
+        :return: list of volume details objects
+        :rtype: list[Volume]
+        """
+        volumes_dicts = self._http_client.get(VOLUMES_ENDPOINT + '/trash').json()
+
+        return list(map(Volume.create_from_dict, volumes_dicts))
+
+    def create(
+        self,
+        type: str,
+        name: str,
+        size: int,
+        instance_id: str | None = None,
+        location: str = Locations.FIN_03,
+    ) -> Volume:
+        """Create new volume.
+
+        :param type: volume type
+        :type type: str
+        :param name: volume name
+        :type name: str
+        :param size: volume size, in GB
+        :type size: int
+        :param instance_id: Instance id to be attached to, defaults to None
+        :type instance_id: str, optional
+        :param location: datacenter location, defaults to "FIN-03"
+        :type location: str, optional
+        :return: the new volume object
+        :rtype: Volume
+        """
+        payload = {
+            'type': type,
+            'name': name,
+            'size': size,
+            'instance_id': instance_id,
+            'location_code': location,
+        }
+        id = self._http_client.post(VOLUMES_ENDPOINT, json=payload).text
+        volume = self.get_by_id(id)
+        return volume
+
+    def attach(self, id_list: list[str] | str, instance_id: str) -> None:
+        """Attach multiple volumes or single volume to an instance.
+
+        Note: the instance needs to be shut-down (offline)
+
+        :param id_list: list of volume ids, or a volume id
+        :type id_list: Union[list[str], str]
+        :param instance_id: instance id the volume(s) will be attached to
+        :type instance_id: str
+        """
+        payload = {
+            'id': id_list,
+            'action': VolumeActions.ATTACH,
+            'instance_id': instance_id,
+        }
+
+        self._http_client.put(VOLUMES_ENDPOINT, json=payload)
+        return
+
+    def detach(self, id_list: list[str] | str) -> None:
+        """Detach multiple volumes or single volume from an instance(s).
+
+        Note: the instances need to be shut-down (offline)
+
+        :param id_list: list of volume ids, or a volume id
+        :type id_list: Union[list[str], str]
+        """
+        payload = {
+            'id': id_list,
+            'action': VolumeActions.DETACH,
+        }
+
+        self._http_client.put(VOLUMES_ENDPOINT, json=payload)
+        return
+
+    def clone(self, id: str, name: str | None = None, type: str | None = None) -> Volume:
+        """Clone a volume or multiple volumes.
+
+        :param id: volume id or list of volume ids
+        :type id: str or list[str]
+        :param name: new volume name
+        :type name: str
+        :param type: volume type
+        :type type: str, optional
+        :return: the new volume object, or a list of volume objects if cloned mutliple volumes
+        :rtype: Volume or list[Volume]
+        """
+        payload = {'id': id, 'action': VolumeActions.CLONE, 'name': name, 'type': type}
+
+        # clone volume(s)
+        volume_ids_array = self._http_client.put(VOLUMES_ENDPOINT, json=payload).json()
+
+        # map the IDs into Volume objects
+        volumes_array = [self.get_by_id(volume_id) for volume_id in volume_ids_array]
+
+        # if the array has only one element, return that element
+        if len(volumes_array) == 1:
+            return volumes_array[0]
+
+        # otherwise return the volumes array
+        return volumes_array
+
+    def rename(self, id_list: list[str] | str, name: str) -> None:
+        """Rename multiple volumes or single volume.
+
+        :param id_list: list of volume ids, or a volume id
+        :type id_list: Union[list[str], str]
+        :param name: new name
+        :type name: str
+        """
+        payload = {'id': id_list, 'action': VolumeActions.RENAME, 'name': name}
+
+        self._http_client.put(VOLUMES_ENDPOINT, json=payload)
+        return
+
+    def increase_size(self, id_list: list[str] | str, size: int) -> None:
+        """Increase size of multiple volumes or single volume.
+
+        :param id_list: list of volume ids, or a volume id
+        :type id_list: Union[list[str], str]
+        :param size: new size in GB
+        :type size: int
+        """
+        payload = {
+            'id': id_list,
+            'action': VolumeActions.INCREASE_SIZE,
+            'size': size,
+        }
+
+        self._http_client.put(VOLUMES_ENDPOINT, json=payload)
+        return
+
+    def delete(self, id_list: list[str] | str, is_permanent: bool = False) -> None:
+        """Delete multiple volumes or single volume.
+
+        Note: if attached to any instances, they need to be shut-down (offline)
+
+        :param id_list: list of volume ids, or a volume id
+        :type id_list: Union[list[str], str]
+        """
+        payload = {
+            'id': id_list,
+            'action': VolumeActions.DELETE,
+            'is_permanent': is_permanent,
+        }
+
+        self._http_client.put(VOLUMES_ENDPOINT, json=payload)
+        return

verda-1.17.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.3
+Name: verda
+Version: 1.17.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.verda.com/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.verda.com/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-1.17.0.dist-info/RECORD

@@ -0,0 +1,36 @@
+verda/InferenceClient/__init__.py,sha256=oe7RQfoKbKJnIFWOt6TNtdzjXk5Gcl4-smO5DjLE6M0,117
+verda/InferenceClient/inference_client.py,sha256=Lqq7NxpisZdRauThoJCNOnRLdh2UdQGUpnFSAy5eqL4,17209
+verda/__init__.py,sha256=b-GHju7CuRktp2jbyQ0b-HOh1LrgXE5fa_fAvRJtl4k,623
+verda/_version.py,sha256=T11BBcYkWMV48TEHtEI08YyNekJT7iKT6JgY-3Xg6Ws,160
+verda/authentication/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/authentication/authentication.py,sha256=rCp46zoQNMoNyJZRIcfXLphZNk18LzMh8a4PgO9-A6Q,3506
+verda/balance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/balance/balance.py,sha256=tMuulgL7U4pSPG2hIts1UkB9KShdqLcrjnR3uhYj7KM,1221
+verda/constants.py,sha256=cL0rj35X1VS-IHisqxwDgn8PXUjGjfuqUqotS4GB98E,2687
+verda/containers/__init__.py,sha256=I6_H8w90MzlHi4MQ-Oo3R7kUopgU4yLRkaSjOAB6jWI,744
+verda/containers/containers.py,sha256=0wgviFHMdO0O0fzZNz5bIgjWhbuL3R17lQmDToBnmSY,35666
+verda/datacrunch.py,sha256=m1AiQbAm3rCBfDnJesuRzD_NA1IiqGWW73V4dd7493I,1376
+verda/exceptions.py,sha256=B0GD8nHDDvBT8meFnrott8kEZtn8PF6eID6Xcdb8RQE,786
+verda/helpers.py,sha256=qvpWNoh1jqfBGxsYPFTNs_fDeF_H7WsalKeCXTH-bDw,657
+verda/http_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/http_client/http_client.py,sha256=ywyJK-PBfHRbatKTl2uqp8UHcpLBrqwyMRL-0tKXv7s,8342
+verda/images/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/images/images.py,sha256=mmuvubOTdnkvVeWX3wkOjm2sQXTpQ0Z-kBqQUL0t5xo,2156
+verda/instance_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/instance_types/instance_types.py,sha256=pc5uo4HKo9Vrqr8uegylhVslZZDClrE9m9UXa67IPxo,2046
+verda/instances/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/instances/instances.py,sha256=o_dq9iqp9_OMSkzwFbO0ucaph9_brm7lT_mb9GESvNM,9690
+verda/locations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/locations/locations.py,sha256=SxmKVgxU8TAas_ca5OBBpi-SkbN87CeWOUEihL8g4Ws,372
+verda/ssh_keys/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/ssh_keys/ssh_keys.py,sha256=5K9UYiNUtKNaUuRb_wGNVMgOJj40YLXlkZaOGoROxio,2868
+verda/startup_scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/startup_scripts/startup_scripts.py,sha256=Q5i5NESB_DOJ9PjCNQFYQubn1CsankMudD217TbfMB8,3129
+verda/verda.py,sha256=Ki7jl4459g2Tz_3fG3vWIs1OsfECy--o3DiTD50Mg_g,3391
+verda/volume_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/volume_types/volume_types.py,sha256=unvFrhWONbOPcsFzf2Oo29IZ8cC5czNRxuAO0dNiVko,1833
+verda/volumes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+verda/volumes/volumes.py,sha256=V_W51f25HkLrr_PTJwfH4Z532xEZlHaG3MxOpNAoy7Q,11536
+verda-1.17.0.dist-info/WHEEL,sha256=YUH1mBqsx8Dh2cQG2rlcuRYUhJddG9iClegy4IgnHik,79
+verda-1.17.0.dist-info/METADATA,sha256=aujtucH0vBcBJiKtRfhXWjdB39eI5f9Ol1s02EnJ2xo,5427
+verda-1.17.0.dist-info/RECORD,,

{verda-0.1.0.dist-info → verda-1.17.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.8.18
+Generator: uv 0.9.11
 Root-Is-Purelib: true
 Tag: py3-none-any

verda-0.1.0.dist-info/METADATA

@@ -1,10 +0,0 @@
-Metadata-Version: 2.3
-Name: verda
-Version: 0.1.0
-Summary: Reserved package name for an upcoming tool
-Author: Alexey Shamrin
-Author-email: Alexey Shamrin <alexey@datacrunch.io>
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-
-Reserved package name for an upcoming tool.

verda-0.1.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-verda/__init__.py,sha256=b0D0eMbK86mxpXwD5aJJ270aHflBixw-Q6guXO73ygs,51
-verda/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-verda-0.1.0.dist-info/WHEEL,sha256=5h_Q-_6zWQhhADpsAD_Xpw7gFbCRK5WjOOEq0nB806Q,79
-verda-0.1.0.dist-info/METADATA,sha256=9E74tHNEXrDcZ6bxQ7rgysQQDJO4hc9y4LjZBewFkPA,285
-verda-0.1.0.dist-info/RECORD,,