fix: examples after migration and rename

Author: Ruslan Gainutdinov

README.md

@@ -58,10 +58,11 @@ This package was originally published under `datacrunch` name, see [MIGRATION.md
   ```python
   import os
   from verda import VerdaClient
+  from verda.constants import Actions
 
-  # Get credentials from environment variables
+  # Get credentials from the environment variables
   CLIENT_ID = os.environ.get('VERDA_CLIENT_ID')
-  CLIENT_SECRET = os.environ['VERDA_CLIENT_SECRET']
+  CLIENT_SECRET = os.environ.get('VERDA_CLIENT_SECRET')
 
   # Create client
   verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
@@ -71,13 +72,13 @@ This package was originally published under `datacrunch` name, see [MIGRATION.md
 
   # Create a new instance
   instance = verda.instances.create(instance_type='1V100.6V',
-                                    image='ubuntu-24.04-cuda-12.8-open-docker',
+                                    image='ubuntu-24.04-cuda-12.6-docker',
                                     ssh_key_ids=ssh_keys,
                                     hostname='example',
                                     description='example instance')
 
   # Delete instance
-  verda.instances.action(instance.id, verda.constants.instance_actions.DELETE)
+  verda.instances.action(instance.id, Actions.DELETE)
   ```
 
   More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/).
@@ -122,7 +123,7 @@ CLIENT_SECRET = 'secret'
 CLIENT_ID = 'your-id'
 
 # Create client
-verda = VerdaClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1')
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
 ```
 
 Run it:

docs/llms.txt

@@ -0,0 +1,350 @@
+# Verda Python SDK
+
+> Official Python SDK for Verda (formerly DataCrunch) cloud computing platform
+> Documentation: https://datacrunch-python.readthedocs.io/en/latest/
+> API Documentation: https://api.verda.com/v1/docs
+> GitHub: https://github.com/verda-cloud/sdk-python
+> PyPI: https://pypi.org/project/verda/
+
+## Installation
+
+```bash
+# via pip
+pip install verda
+
+# via uv
+uv add verda
+```
+
+## Authentication
+
+Generate client credentials through the Verda dashboard (see API docs for details).
+
+```python
+from verda import VerdaClient
+
+CLIENT_ID = 'your-client-id'
+CLIENT_SECRET = 'your-client-secret'
+
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+# With custom base URL (for development)
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+# With inference key for container inference (optional)
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET, inference_key='your-inference-key')
+```
+
+## Available Services
+
+### Instances Service (`verda.instances`)
+Deploy, manage, and monitor compute instances.
+
+Methods:
+- `get()` - List all instances
+- `get_by_id(instance_id)` - Get specific instance
+- `create(instance_type, image, ssh_key_ids, hostname, description, ...)` - Create new instance
+- `action(instance_id, action, volume_ids=None)` - Perform action on instance
+
+### Volumes Service (`verda.volumes`)
+Create and manage storage volumes.
+
+Methods:
+- `get()` - List all volumes
+- `get_by_id(volume_id)` - Get specific volume
+- `create(volume_type, name, size, location)` - Create new volume
+- `action(volume_id, action, ...)` - Perform action on volume
+
+### SSH Keys Service (`verda.ssh_keys`)
+Manage SSH keys for instance access.
+
+Methods:
+- `get()` - List all SSH keys
+- `get_by_id(key_id)` - Get specific SSH key
+- `create(name, public_key)` - Add new SSH key
+- `delete(key_id)` - Delete SSH key
+
+### Startup Scripts Service (`verda.startup_scripts`)
+Manage startup scripts for instances.
+
+Methods:
+- `get()` - List all startup scripts
+- `get_by_id(script_id)` - Get specific script
+- `create(name, script_content)` - Create new script
+- `delete(script_id)` - Delete script
+
+### Containers Service (`verda.containers`)
+Deploy and manage container deployments for inference and services.
+
+Methods:
+- `deployments.get()` - List all deployments
+- `deployments.get_by_id(deployment_id)` - Get specific deployment
+- `deployments.create(...)` - Create new deployment
+- `deployments.update(deployment_id, ...)` - Update deployment
+- `deployments.delete(deployment_id)` - Delete deployment
+- `inference(deployment_id, ...)` - Send inference request
+
+### Instance Types Service (`verda.instance_types`)
+Get available instance types and their specifications.
+
+Methods:
+- `get()` - List all instance types
+
+### Volume Types Service (`verda.volume_types`)
+Get available volume types.
+
+Methods:
+- `get()` - List all volume types
+
+### Images Service (`verda.images`)
+Get available OS images.
+
+Methods:
+- `get()` - List all images
+
+### Balance Service (`verda.balance`)
+Check account balance.
+
+Methods:
+- `get()` - Get current balance
+
+### Locations Service (`verda.locations`)
+Get available datacenter locations.
+
+Methods:
+- `get()` - List all locations
+
+## Constants
+
+Import constants from `verda.constants`:
+
+```python
+from verda.constants import Actions, VolumeActions, InstanceStatus, VolumeStatus, VolumeTypes, Locations, ErrorCodes
+```
+
+### Actions (Instance Actions)
+- `Actions.START` - Start instance
+- `Actions.SHUTDOWN` - Shutdown instance
+- `Actions.DELETE` - Delete instance
+- `Actions.HIBERNATE` - Hibernate instance
+- `Actions.RESTORE` - Restore hibernated instance
+
+### VolumeActions
+- `VolumeActions.ATTACH` - Attach volume to instance
+- `VolumeActions.DETACH` - Detach volume from instance
+- `VolumeActions.RENAME` - Rename volume
+- `VolumeActions.INCREASE_SIZE` - Increase volume size
+- `VolumeActions.DELETE` - Delete volume
+- `VolumeActions.CLONE` - Clone volume
+
+### InstanceStatus
+- `InstanceStatus.ORDERED` - Instance ordered
+- `InstanceStatus.RUNNING` - Instance running
+- `InstanceStatus.PROVISIONING` - Instance provisioning
+- `InstanceStatus.OFFLINE` - Instance offline
+- `InstanceStatus.STARTING_HIBERNATION` - Starting hibernation
+- `InstanceStatus.HIBERNATING` - Instance hibernating
+- `InstanceStatus.RESTORING` - Restoring from hibernation
+- `InstanceStatus.ERROR` - Instance in error state
+
+### VolumeStatus
+- `VolumeStatus.ORDERED` - Volume ordered
+- `VolumeStatus.CREATING` - Volume creating
+- `VolumeStatus.ATTACHED` - Volume attached
+- `VolumeStatus.DETACHED` - Volume detached
+- `VolumeStatus.DELETING` - Volume deleting
+- `VolumeStatus.DELETED` - Volume deleted
+- `VolumeStatus.CLONING` - Volume cloning
+
+### VolumeTypes
+- `VolumeTypes.NVMe` - NVMe SSD storage
+- `VolumeTypes.HDD` - HDD storage
+- `VolumeTypes.SFS` - Shared filesystem (NVMe_Shared)
+
+### Locations
+- `Locations.FIN_01` - Finland datacenter 1
+- `Locations.FIN_02` - Finland datacenter 2
+- `Locations.FIN_03` - Finland datacenter 3
+- `Locations.ICE_01` - Iceland datacenter 1
+
+### ErrorCodes
+- `ErrorCodes.INVALID_REQUEST` - Invalid request
+- `ErrorCodes.UNAUTHORIZED_REQUEST` - Unauthorized request
+- `ErrorCodes.INSUFFICIENT_FUNDS` - Insufficient funds
+- `ErrorCodes.FORBIDDEN_ACTION` - Forbidden action
+- `ErrorCodes.NOT_FOUND` - Resource not found
+- `ErrorCodes.SERVER_ERROR` - Server error
+- `ErrorCodes.SERVICE_UNAVAILABLE` - Service unavailable
+
+## Common Usage Patterns
+
+### Creating an Instance
+
+```python
+from verda import VerdaClient
+from verda.constants import Locations
+
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+# Get SSH keys
+ssh_keys = [key.id for key in verda.ssh_keys.get()]
+
+# Create instance
+instance = verda.instances.create(
+    instance_type='1V100.6V',
+    image='ubuntu-24.04-cuda-12.8-open-docker',
+    location=Locations.FIN_03,
+    ssh_key_ids=ssh_keys,
+    hostname='my-instance',
+    description='My GPU instance'
+)
+
+print(f"Created instance: {instance.id}")
+```
+
+### Managing Instances
+
+```python
+from verda.constants import Actions, InstanceStatus
+import time
+
+# Wait for instance to be running
+while instance.status != InstanceStatus.RUNNING:
+    time.sleep(30)
+    instance = verda.instances.get_by_id(instance.id)
+
+# Shutdown instance
+verda.instances.action(instance.id, Actions.SHUTDOWN)
+
+# Wait for instance to be offline
+while instance.status != InstanceStatus.OFFLINE:
+    time.sleep(30)
+    instance = verda.instances.get_by_id(instance.id)
+
+# Hibernate instance
+verda.instances.action(instance.id, Actions.HIBERNATE)
+
+# Delete instance (with OS volume)
+verda.instances.action(instance.id, Actions.DELETE)
+
+# Delete instance without deleting OS volume
+verda.instances.action(instance.id, Actions.DELETE, volume_ids=[])
+```
+
+### Working with Volumes
+
+```python
+from verda.constants import VolumeTypes, VolumeActions
+
+# Create instance with extra volumes
+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='Instance with extra volumes',
+    volumes=[
+        {'type': VolumeTypes.HDD, 'name': 'data-volume', 'size': 500},
+        {'type': VolumeTypes.NVMe, 'name': 'fast-storage', 'size': 100},
+    ]
+)
+
+# Create standalone volume
+volume = verda.volumes.create(
+    volume_type=VolumeTypes.NVMe,
+    name='my-volume',
+    size=100,
+    location=Locations.FIN_03
+)
+
+# Attach volume to instance
+verda.volumes.action(
+    volume_id=volume.id,
+    action=VolumeActions.ATTACH,
+    instance_id=instance.id
+)
+
+# Detach volume
+verda.volumes.action(
+    volume_id=volume.id,
+    action=VolumeActions.DETACH
+)
+
+# Delete volume
+verda.volumes.action(volume.id, VolumeActions.DELETE)
+```
+
+### Container Deployments
+
+```python
+# Create container deployment
+deployment = verda.containers.deployments.create(
+    name='my-model',
+    image='registry.example.com/my-model:latest',
+    replicas=2,
+    compute_resources={
+        'cpu': 4,
+        'memory': 16,
+        'gpu': 1
+    },
+    environment_variables=[
+        {'name': 'MODEL_PATH', 'value': '/models/model.bin'}
+    ],
+    ports=[{'container_port': 8080, 'protocol': 'http'}]
+)
+
+# Send inference request
+result = verda.containers.inference(
+    deployment_id=deployment.id,
+    prompt='Hello, world!',
+    max_tokens=100
+)
+
+# Update deployment scaling
+verda.containers.deployments.update(
+    deployment_id=deployment.id,
+    replicas=4
+)
+
+# Delete deployment
+verda.containers.deployments.delete(deployment.id)
+```
+
+## Exception Handling
+
+```python
+from verda.exceptions import APIException
+
+try:
+    verda.instances.action(instance.id, Actions.SHUTDOWN)
+except APIException as e:
+    print(f"API Error: {e}")
+    # Access error details
+    print(f"Status code: {e.status_code}")
+    print(f"Error code: {e.error_code}")
+    print(f"Message: {e.message}")
+```
+
+## Migration from DataCrunch
+
+The SDK was originally published as `datacrunch`. If migrating:
+
+1. Replace `datacrunch` imports with `verda`
+2. Update constant paths: `verda.constants.instance_actions` → `Actions` (import from `verda.constants`)
+3. See MIGRATION.md for detailed migration guide
+
+## Best Practices
+
+1. **Store credentials securely**: Use environment variables, never hardcode
+2. **Handle rate limits**: Implement exponential backoff for retries
+3. **Check instance status**: Wait for instances to reach desired state before performing actions
+4. **Clean up resources**: Delete instances and volumes when no longer needed
+5. **Use SSH keys**: Always configure SSH keys for secure instance access
+6. **Monitor balance**: Check balance regularly to avoid service interruptions
+
+## Additional Resources
+
+- Full API documentation: https://api.verda.com/v1/docs
+- SDK documentation: https://datacrunch-python.readthedocs.io/en/latest/
+- Examples: https://github.com/verda-cloud/sdk-python/tree/master/examples
+- Support: https://verda.com/contact