add 2 examples to documentation

Author: tamirse

.gitignore

@@ -141,4 +141,5 @@ dmypy.json
 cython_debug/
 
 # python sphinx docs
-_build/
+_build/
+testing.py

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+v1.0.2 (2021-06-16)
+-------------------
+
+* Added examples to documentation
+
 v1.0.1 (2021-06-16)
 -------------------
 

datacrunch/__version__.py

@@ -1 +1 @@
-VERSION = '1.0.1'
+VERSION = '1.0.2'

docs/source/examples/instances_and_volumes.rst

@@ -0,0 +1,58 @@
+Instances and Volumes
+=====================
+
+.. code-block:: python
+
+    import os
+    from datacrunch import DataCrunchClient
+
+    # Get client secret from environment variable
+    CLIENT_SECRET = os.environ['DATACRUNCH_CLIENT_SECRET']
+    CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi'  # Replace with your client ID
+
+    # Create datcrunch client
+    datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET)
+
+    # Get some volume type constants
+    NVMe = datacrunch.constants.volume_types.NVMe
+    HDD = datacrunch.constants.volume_types.HDD
+
+    EXISTING_OS_VOLUME_ID = '81e45bf0-5da2-412b-97d7-c20a7564fca0'
+    EXAMPLE_VOLUME_ID = '225dde24-ae44-4787-9224-2b9f56f44394'
+    EXAMPLE_INSTANCE_ID = '1eeabba4-caf7-4b4a-9143-0107034cc7f5'
+
+    # Get all SSH keys
+    ssh_keys = datacrunch.ssh_keys.get()
+
+    # Create instance with extra attached volumes
+    instance_with_extra_volumes = datacrunch.instances.create(instance_type='1V100.6V',
+                                                            image='fastai',
+                                                            ssh_key_ids=ssh_keys[0].id,
+                                                            hostname='example',
+                                                            description='example instance',
+                                                            volumes=[
+                                                                        {"type": HDD, "name": "volume-1", "size": 95},
+                                                                        {"type": NVMe, "name": "volume-2", "size": 95}
+                                                            ])
+
+    # Create instance with existing OS volume as an image
+    instance_with_existing_os_volume = datacrunch.instances.create(instance_type='1V100.6V',
+                                                                image=EXISTING_OS_VOLUME_ID,
+                                                                ssh_key_ids=ssh_keys[0].id,
+                                                                hostname='example',
+                                                                description='example instance')
+
+    # Delete instance AND OS volume (the rest of the volumes would be detached)
+    datacrunch.instances.action(instance_id=EXAMPLE_INSTANCE_ID,
+                                action=datacrunch.constants.instance_actions.DELETE)
+
+    # Delete instance WITHOUT deleting the OS volume (will detach all volumes of the instance)
+    datacrunch.instances.action(instance_id=EXAMPLE_INSTANCE_ID,
+                                action=datacrunch.constants.instance_actions.DELETE,
+                                volume_ids=[])
+
+
+    # Delete instance and one of it's volumes (will delete one volume, detach the rest)
+    datacrunch.instances.action(instance_id=EXAMPLE_INSTANCE_ID,
+                                action=datacrunch.constants.instance_actions.DELETE,
+                                volume_ids=[EXAMPLE_VOLUME_ID])

docs/source/examples/storage_volumes.rst

@@ -0,0 +1,60 @@
+Storage Volumes
+===============
+
+.. code-block:: python
+
+    import os
+    from datacrunch import DataCrunchClient
+
+    # Get client secret from environment variable
+    CLIENT_SECRET = os.environ['DATACRUNCH_CLIENT_SECRET']
+    CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi'  # Replace with your client ID
+
+    # Create datcrunch client
+    datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET)
+
+    # Get some volume type constants
+    NVMe = datacrunch.constants.volume_types.NVMe
+    HDD = datacrunch.constants.volume_types.HDD
+
+    # Example instance id
+    INSTANCE_ID = '8705bb38-2574-454f-9967-d18b130bf5ee'
+
+    # Get all volumes
+    all_volumes = datacrunch.volumes.get()
+
+    # Get all attached volumes
+    all_attached_volumes = datacrunch.volumes.get(status=datacrunch.constants.volume_status.ATTACHED)
+
+    # Get volume by id
+    random_volume = datacrunch.volumes.get_by_id("0c41e387-3dd8-495f-a285-e861527f2f3d")
+
+    # Create a 200 GB detached NVMe volume
+    nvme_volume = datacrunch.volumes.create(type=NVMe,
+                                            name="data-storage-1",
+                                            size=200)
+
+    # Create a 500 GB HDD volume and attach it to an existing shutdown instance
+    # Note: If the instance isn't shutdown an exception would be raised
+    hdd_volume = datacrunch.volumes.create(type=HDD,
+                                        name="data-storage-2",
+                                        size=500,
+                                        instance_id=INSTANCE_ID)
+
+    nvme_volume_id = nvme_volume.id
+    hdd_volume_id = hdd_volume.id
+
+    # attach the nvme volume to the instance
+    datacrunch.volumes.attach(nvme_volume_id, INSTANCE_ID)
+
+    # detach both volumes from the instance
+    datacrunch.volumes.detach([nvme_volume_id, hdd_volume_id])
+
+    # rename volume
+    datacrunch.volumes.rename(nvme_volume_id, "new-name")
+
+    # increase volume size
+    datacrunch.volumes.increase_size(nvme_volume_id, 300)
+
+    # delete volumes
+    datacrunch.volumes.delete([nvme_volume_id, hdd_volume_id])