Update Examples

Author: smashedr

.github/workflows/build.yaml

@@ -55,17 +55,13 @@ jobs:
           python -m build
 
       - name: "List Artifacts"
-        env:
-          path: ${{ inputs.path }}
+        working-directory: ${{ inputs.path }}
         run: |
-          echo "::group::ls"
-          ls -lAhR "${path}"
-          echo "::endgroup::"
-          echo "::group::tree"
-          tree "${path}"
+          results="$(tree . || ls -lAhR .)"
+          echo "::group::results"
+          echo "${results}"
           echo "::endgroup::"
-          results="$(tree "${path}")"
-          markdown='Artifacts:\n```text\n'"${results}"'\n```'
+          markdown='Artifacts: `${{ inputs.path }}`\n```text\n'"${results}"'\n```'
           echo -e "${markdown}" >> $GITHUB_STEP_SUMMARY
 
       - name: "Upload to Actions"

README.md

@@ -39,7 +39,6 @@ Python 3 wrapper for the Vultr API v2.
 Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
 
 > [!TIP]  
-> This project is not complete, but has many useful functions.  
 > Please submit a [Feature Request](https://github.com/cssnr/vultr-python/discussions/categories/feature-requests)
 > or report any [Issues](https://github.com/cssnr/vultr-python/issues).
 
@@ -62,12 +61,11 @@ python -m pip install vultr-python
 
 ## Usage
 
-You will need to create an api key and whitelist your IP address.
-Most functions do not work without an API Key.
+You will need to create an api key and whitelist your IP address for most functions.
 
 - [https://my.vultr.com/settings/#settingsapi](https://my.vultr.com/settings/#settingsapi)
 
-Initialize the class with your API Key or with the `VULTR_API_KEY` environment variable.
+Initialize the `Vultr` class with your API Key or use the `VULTR_API_KEY` environment variable.
 
 ```python
 from vultr import Vultr
@@ -112,16 +110,23 @@ instance = vultr.create_instance(available[0], plan, **data)
 Arbitrary Methods `get`, `post`, `patch`, `delete`
 
 ```python
-# vultr.get('url', params)
-instances = vultr.get('instances', {'type': 'vc2'})
-# vultr.post('url', **kwargs)
+plans = vultr.get('plans', {'type': 'vc2'})
 sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
-# vultr.delete('url')
+instance = vultr.patch('instances', plan=plans[1]['id'])
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 
 Error Handling
 
+```python
+>>> instance = vultr.create_instance("atl", "vc2-1c-0.5gb-v6", **data)
+Traceback (most recent call last):
+    ...
+vultr.vultr.VultrException: Error 400: Server add failed: Ubuntu 24.04 LTS x64 requires a plan with at least 1000 MB memory.
+```
+
+Using the `VultrException` class
+
 ```python
 from vultr import VultrException
 

docs/index.md

@@ -88,8 +88,9 @@ instance = vultr.create_instance(available[0], plan, **data)
 Arbitrary Methods `get`, `post`, `patch`, `delete`
 
 ```python
-instances = vultr.get('instances', {'type': 'vc2'})
+plans = vultr.get('plans', {'type': 'vc2'})
 sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
+instance = vultr.patch('instances', plan=plans[1]['id'])
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 

docs/module.html.jinja2

@@ -38,3 +38,9 @@
   </script>
 
 {% endblock %}
+
+{#{% block nav_footer %}#}
+{#  <footer>My Package v{{ env["VERSION"] | default("1.0") }}</footer>#}
+{#{% endblock %}#}
+
+{#{% block attribution %}{% endblock %}#}