Add Arbitrary Methods

Author: smashedr

README.md

@@ -20,7 +20,7 @@
 # Vultr Python
 
 <a title="Vultr Python" href="https://cssnr.github.io/vultr-python" target="_blank">
-<img alt="Vultr Python" align="right" width="128" height="auto" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/vultr-python/logo128.png"></a>
+<img alt="Vultr Python" align="right" width="128" height="auto" src="https://raw.githubusercontent.com/cssnr/vultr-python/refs/heads/master/.github/assets/logo.svg"></a>
 
 - [Install](#Install)
 - [Usage](#Usage)
@@ -110,6 +110,17 @@ data = {
 instance = vultr.create_instance(**data)
 ```
 
+Arbitrary Methods `get`, `post`, `patch`, `delete`
+
+```python
+# vultr.list_instances()
+instances = vultr.get('instances')
+# vultr.create_key()
+sshkey = vultr.post('ssh-keys', {"name": 'key-name', "ssh_key": 'ssh-rsa AAAA...'})
+# vultr.delete_instance()
+vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
+```
+
 Full Documentation: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
 
 Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)

build.ps1

@@ -0,0 +1,48 @@
+param (
+    [switch]$c,
+    [switch]$i,
+    [switch]$u
+)
+
+$ErrorActionPreference = "Stop"
+
+write-output "Clean:      $c"
+write-output "Install:    $i"
+write-output "Uninstall:  $u"
+
+if ($u) {
+    Write-Host -ForegroundColor Red "Uninstalling..."
+    python -m pip uninstall -y vultr-python
+}
+
+$egg_dir = ".\src\*.egg-info"
+if (Test-Path $egg_dir) {
+    Write-Host -ForegroundColor Cyan "Removing: $egg_dir"
+    Remove-Item -Force -Recurse $egg_dir
+}
+$cache_dir = ".\src\*\__pycache__"
+if (Test-Path $cache_dir) {
+    Write-Host -ForegroundColor Cyan "Removing: $cache_dir"
+    Remove-Item -Force -Recurse $cache_dir
+}
+if (Test-Path ".\dist") {
+    Write-Host -ForegroundColor Cyan "Removing: .\dist"
+    Remove-Item -Force -Recurse ".\dist"
+}
+if (Test-Path ".\build") {
+    Write-Host -ForegroundColor Cyan "Removing: .\build"
+    Remove-Item -Force -Recurse ".\build"
+}
+if ($c) {
+    Write-Host -ForegroundColor Yellow "Clean Only. Not Building or Installing!"
+    exit
+}
+
+python -m build
+
+if ($args[0] -eq "i") {
+    Write-Host -ForegroundColor Green "Installing..."
+    python -m pip install .\dist\vultr_python-0.0.1-py3-none-any.whl
+}
+
+Write-Output "Success."

docs.ps1

@@ -0,0 +1,38 @@
+param (
+    [switch]$c,
+    [switch]$b
+)
+
+$ErrorActionPreference = "Stop"
+
+write-output "Clean:    $c"
+write-output "Build:    $b"
+
+if ($c) {
+    Write-Host -ForegroundColor Yellow "Cleaning Docs..."
+    $site_dir = ".\site"
+    if (Test-Path $site_dir) {
+        Write-Host -ForegroundColor Cyan "Removing: $site_dir"
+        Remove-Item -Force -Recurse $site_dir
+    }
+    $cache_dir = ".\.cache"
+    if (Test-Path $cache_dir) {
+        Write-Host -ForegroundColor Cyan "Removing: $cache_dir"
+        Remove-Item -Force -Recurse $cache_dir
+    }
+}
+
+python -m pdoc -t .\docs\ -p 8008 `
+    --favicon "https://df.cssnr.com/raw/logo128.png" `
+    --logo "https://df.cssnr.com/raw/logo128.png" `
+    --logo-link "https://github.com/cssnr/vultr-python" `
+    vultr
+
+#-e "vultr=https://github.com/cssnr/vultr-python/blob/updates/src/vultr/" `
+
+#if ($b) {
+#    Write-Host -ForegroundColor Green "Building Docs..."
+#    zensical build
+#} else {
+#    zensical serve
+#}

docs/index.md

@@ -88,6 +88,17 @@ data = {
 instance = vultr.create_instance(**data)
 ```
 
+Arbitrary Methods `get`, `post`, `patch`, `delete`
+
+```python
+# vultr.list_instances()
+instances = vultr.get('instances')
+# vultr.create_key()
+sshkey = vultr.post('ssh-keys', {"name": 'key-name', "ssh_key": 'ssh-rsa AAAA...'})
+# vultr.delete_instance()
+vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
+```
+
  
 
 Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)

src/vultr/py.typed

@@ -9,12 +9,24 @@ class Vultr(object):
 
     def __init__(self, api_key: Optional[str] = None):
         """
-        :param str api_key: Vultr API Key or VULTR_API_KEY environment variable
+        :param str api_key: Vultr API Key or VULTR_API_KEY Environment Variable
         """
         self.api_key = api_key or os.getenv("VULTR_API_KEY")
-        self.s = requests.session()
+        self._session = requests.session()
         if self.api_key:
-            self.s.headers.update({"Authorization": f"Bearer {self.api_key}"})
+            self._session.headers.update({"Authorization": f"Bearer {self.api_key}"})
+
+    def get(self, url: str):
+        return self._get(f"{self.url}/{url.lstrip('/')}")
+
+    def post(self, url: str, **kwargs):
+        return self._post(f"{self.url}/{url.lstrip('/')}", kwargs)
+
+    def patch(self, url: str, **kwargs):
+        return self._patch(f"{self.url}/{url.lstrip('/')}", kwargs)
+
+    def delete(self, url: str):
+        return self._delete(f"{self.url}/{url.lstrip('/')}")
 
     def list_os(self):
         url = f"{self.url}/os"
@@ -144,25 +156,25 @@ def filter_regions(regions: list, locations: list) -> list:
         return [d for d in regions if d["id"] in locations]
 
     def _get(self, url):
-        r = self.s.get(url, timeout=10)
+        r = self._session.get(url, timeout=10)
         if not r.ok:
             r.raise_for_status()
         return r.json()
 
     def _post(self, url, data):
-        r = self.s.post(url, json=data, timeout=10)
+        r = self._session.post(url, json=data, timeout=10)
         if not r.ok:
             r.raise_for_status()
         return r.json()
 
     def _patch(self, url, data):
-        r = self.s.patch(url, json=data, timeout=10)
+        r = self._session.patch(url, json=data, timeout=10)
         if not r.ok:
             r.raise_for_status()
         return r.json()
 
     def _delete(self, url):
-        r = self.s.delete(url, timeout=10)
+        r = self._session.delete(url, timeout=10)
         if not r.ok:
             r.raise_for_status()
         return None