duplocloud-client 0.0.4__tar.gz

duplocloud-client-0.0.4/.coveragerc

@@ -0,0 +1,6 @@
+[run]
+omit = 
+    *_test.py
+    foo.py
+    src/conftest.py
+    **/__*__.py

duplocloud-client-0.0.4/.github/workflows/publish.yaml

@@ -0,0 +1,38 @@
+name: Python Publish
+
+on:
+  push:
+    tags:        
+    - '*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+
+    # checkout code 
+    - name: Checkout Code
+      uses: actions/checkout@v3
+    
+    # install python
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+    
+    # install the project
+    - name: Install Dependencies
+      run: |
+        pip install -r dev-requirements.txt
+        pip install .
+    
+    - name: Run the Build
+      run: |
+        version=$(python -m setuptools_scm)
+        echo "Building Version: $version"
+        python -m build
+
+    - name: Publish Package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

duplocloud-client-0.0.4/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Python Test
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+
+    # checkout code 
+    - name: Checkout Code
+      uses: actions/checkout@v3
+    
+    # install python
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    # install the project
+    - name: Install dependencies
+      run: |
+        pip install -r dev-requirements.txt
+        pip install .
+    
+    # do linting
+    - name: Lint with ruff
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        ruff --format=github --select=E9,F63,F7,F82 --target-version=py37 .
+    
+    # run the tests
+    - name: Test with pytest
+      run: |
+      
+        pytest src

duplocloud-client-0.0.4/.gitignore

@@ -0,0 +1,8 @@
+build
+dist
+*.egg-info
+.ruff_cache
+.pytest_cache
+.coverage
+__pycache__
+.direnv

duplocloud-client-0.0.4/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "wiki"]
+	path = wiki
+	url = https://github.com/duplocloud/py-client.wiki.git

duplocloud-client-0.0.4/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing  
+
+Follow these steps to be proper. 
+
+## Version Bump  
+
+Make sure you have the duplo git-bump installed and then run
+
+```sh
+git bump -v '[patch, major, minor]'
+```
+e.g. a small patch do this:
+```sh
+git bump -v patch
+```
+
+Doing this creates a proper semver which will trigger a new publish pipeline. 
+
+## Build  
+
+Build the package which creates the artifact in the dist folder. 
+```
+python -m build
+```
+
+## Semver with Setuptools SCM command  
+
+Get the current version
+```
+python -m setuptools_scm
+```
+
+When building the artifact the setuptools scm tool will use the a snazzy semver logic to determine version. 
+
+*ref:* [SetupTools SCM](https://pypi.org/project/setuptools-scm/)

duplocloud-client-0.0.4/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: duplocloud-client
+Version: 0.0.4
+Summary: Generic DuploClient for Python apps.
+Home-page: https://github.com/duplocloud/py-client
+Author: Kelly Ferrone
+Author-email: kelly@duplocloud.net
+Project-URL: Bug Tracker, https://github.com/duplocloud/py-client/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# Duplocloud Py Client  
+
+A package to spawn service clients for working with Duplocloud. 
+
+## Installation  
+
+From PyPi:
+```
+pip install duplocloud-client
+```
+
+From source:
+```
+pip install .
+```
+

duplocloud-client-0.0.4/README.md

@@ -0,0 +1,16 @@
+# Duplocloud Py Client  
+
+A package to spawn service clients for working with Duplocloud. 
+
+## Installation  
+
+From PyPi:
+```
+pip install duplocloud-client
+```
+
+From source:
+```
+pip install .
+```
+

duplocloud-client-0.0.4/dev-requirements.txt

@@ -0,0 +1,9 @@
+pytest
+ruff 
+pytest-black
+pytest-isort 
+pytest-cov 
+invoke
+setuptools_scm
+build
+twine

duplocloud-client-0.0.4/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "duplocloud-client"
+dynamic = ["version"]
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools_scm[toml]>=6.2",
+    "wheel",
+    "build",
+    "twine"
+]
+build-backend = "setuptools.build_meta"
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--verbose --cov=src --cov-report term-missing"
+testpaths = [
+    "tests",
+    "integration",
+]
+[tool.setuptools_scm]

duplocloud-client-0.0.4/setup.cfg

@@ -0,0 +1,40 @@
+[metadata]
+name = duplocloud-client
+author = Kelly Ferrone
+author_email = kelly@duplocloud.net
+description = Generic DuploClient for Python apps.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/duplocloud/py-client
+project_urls = 
+	Bug Tracker = https://github.com/duplocloud/py-client/issues
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+include_package_data = True
+python_requires = >=3.6
+install_requires = 
+	requests >= 2.22.0
+	cachetools >= 5.2.0
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts = 
+	duploctl = duplocloud.cli:main
+duplocloud.net = 
+	service = duplo_resource.service:DuploService
+	tenant = duplo_resource.tenant:DuploTenant
+	user = duplo_resource.user:DuploUser
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

duplocloud-client-0.0.4/setup.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3 
+
+from setuptools import setup
+
+if __name__ == '__main__':
+    setup()

duplocloud-client-0.0.4/src/duplo_resource/service.py

@@ -0,0 +1,32 @@
+from duplocloud.client import DuploClient
+from duplocloud.resource import DuploResource
+from duplocloud.errors import DuploError
+
+class DuploService(DuploResource):
+  
+  def __init__(self, duplo: DuploClient):
+    super().__init__(duplo)
+    self.tenent_svc = duplo.service('tenant')
+  
+  def list(self):
+    """Retrieve a list of all services in a tenant."""
+    tenant_id = self.get_tenant()["TenantId"]
+    return self.duplo.get(f"subscriptions/{tenant_id}/GetReplicationControllers")
+  
+  def find(self, service_name):
+    """Find a service by name."""
+    try:
+      return [s for s in self.list() if s["Name"] == service_name][0]
+    except IndexError:
+      raise DuploError(f"Service '{service_name}' not found", 404)
+
+  def update_image(self, service_name, image):
+    tenant_id = self.get_tenant()["TenantId"]
+    service = self.find(service_name)
+    allocation_tags = service["Template"]["AllocationTags"]
+    data = {
+      "Name": service_name,
+      "Image": image,
+      "AllocationTags": allocation_tags
+    }
+    return self.duplo.post(f"subscriptions/{tenant_id}/ReplicationControllerChange", data)

duplocloud-client-0.0.4/src/duplo_resource/tenant.py

@@ -0,0 +1,18 @@
+from duplocloud.client import DuploClient
+from duplocloud.resource import DuploResource
+from duplocloud.errors import DuploError
+
+class DuploTenant(DuploResource):
+  def __init__(self, duplo: DuploClient):
+    super().__init__(duplo)
+  
+  def list(self):
+    """Retrieve a list of all tenants in the Duplo system."""
+    return self.duplo.get("adminproxy/GetTenantNames")
+
+  def find(self, tenant_name):
+    """Find a tenant by name."""
+    try:
+      return [t for t in self.list() if t["AccountName"] == tenant_name][0]
+    except IndexError:
+      raise DuploError(f"Tenant '{tenant_name}' not found", 404)

duplocloud-client-0.0.4/src/duplo_resource/user.py

@@ -0,0 +1,33 @@
+from duplocloud.client import DuploClient
+from duplocloud.resource import DuploResource
+from duplocloud.errors import DuploError
+
+class DuploUser(DuploResource):
+  def __init__(self, duplo: DuploClient):
+    super().__init__(duplo)
+    self.tenent_svc = duplo.service('tenant')
+  
+  def add_tenant(self, username, tenant):
+    """Retrieve a list of all tenants in the Duplo system."""
+    tenant_id = self.tenent_svc.find(tenant)["TenantId"]
+    res = self.duplo.post("admin/UpdateUserAccess", {
+      "Policy": { "IsReadOnly": None },
+      "Username": username,
+      "TenantId": tenant_id
+    })
+    # check http response is 204
+    if res.status_code != 204:
+      raise DuploError(f"Failed to add user '{username}' to tenant '{tenant}'", res["status_code"])
+    else:
+      return f"User '{username}' added to tenant '{tenant}'"
+
+  def find(self, username):
+    """Find a User by their username."""
+    try:
+      return [u for u in self.list() if u["Username"] == username][0]
+    except IndexError:
+      raise DuploError(f"User '{username}' not found", 404)
+    
+  def list(self):
+    """Retrieve a list of all users in the Duplo system."""
+    return self.duplo.get("admin/GetAllUserRoles")

duplocloud-client-0.0.4/src/duplocloud/cli.py

@@ -0,0 +1,34 @@
+from .client import DuploClient
+import argparse
+import os
+
+def main():
+  env, args = load_env()
+  client = DuploClient(
+    host=env.host,
+    token=env.token,
+    tenant=env.tenant
+  )
+  service = client.service(env.service)
+  service.exec(env.subcmd, args)
+
+def load_env():
+  """Get the environment variables for the Duplo session."""
+  parser = argparse.ArgumentParser(
+    prog='duplocloud-cli',
+    description='Duplo Cloud CLI',
+  )
+  parser.add_argument('service', help='The service to run')
+  parser.add_argument('subcmd', help='The subcommand to run')
+  parser.add_argument('-t', '--tenant', 
+                      help='The tenant to be scope into',
+                      default=os.getenv('DUPLO_TENANT', 'default'))
+  parser.add_argument('-H', '--host', 
+                      help='The tenant to be scope into',
+                      default=os.getenv('DUPLO_HOST', None))
+  parser.add_argument('-p', '--token', 
+                      help='The token/password to authenticate with',
+                      default=os.getenv('DUPLO_TOKEN', None))
+  return parser.parse_known_args()
+
+

duplocloud-client-0.0.4/src/duplocloud/cli_test.py

@@ -0,0 +1,4 @@
+import pytest 
+
+def test_app():
+    assert True

duplocloud-client-0.0.4/src/duplocloud/client.py

@@ -0,0 +1,56 @@
+
+import requests
+from cachetools import cached, TTLCache
+from importlib.metadata import entry_points
+import os
+
+ENTRYPOINT="duplocloud.net"
+
+class DuploClient():
+    
+  def __init__(self, host, token, tenant="default", args=[]) -> None:
+    self.host = host
+    self.timeout = 10
+    self.args = args
+    self.tenant = tenant
+    self.headers = {
+      'Content-Type': 'application/json',
+      'Authorization': f"Bearer {token}"
+    }
+  
+  def __str__(self) -> str:
+     return f"""
+Client for Duplo at {self.host}
+"""
+
+  @cached(cache=TTLCache(maxsize=128, ttl=60))
+  def get(self, path):
+    response = requests.get(
+      url=f"{self.host}/{path}",
+      headers=self.headers,
+      timeout=self.timeout
+    )
+    return response.json()
+  
+  def post(self, path, data={}):
+    return requests.post(
+      url=f"{self.host}/{path}",
+      headers=self.headers,
+      timeout=self.timeout,
+      json=data
+    )
+  
+  def service(self, name):
+    """Load Service
+      
+    Load a Service class from the entry points.
+    Args:
+      name: The name of the service.
+    Returns:
+      The callable krm function
+    """
+    eps = entry_points()[ENTRYPOINT]
+    # e = entry_points(group=group, name=kind)
+    e = [ep for ep in eps if ep.name == name][0]
+    svc = e.load() 
+    return svc(self)

duplocloud-client-0.0.4/src/duplocloud/errors.py

@@ -0,0 +1,9 @@
+
+class DuploError(Exception):
+    """Base class for Duplo errors."""
+    def __init__(self, message, code=1, response=None):
+        super().__init__(message)
+        self.code = code
+        self.response = response
+    def __str__(self):
+        return f"{self.code}: {self.message}"

duplocloud-client-0.0.4/src/duplocloud/resource.py

@@ -0,0 +1,22 @@
+from .client import DuploClient
+from .errors import DuploError
+
+class DuploResource():
+  
+  def __init__(self, duplo: DuploClient):
+    self.duplo = duplo
+    self.tenant = None
+  
+  def get_tenant(self):
+    if not self.tenant:
+      self.tenant_svc = self.duplo.service("tenant")
+      self.tenant = self.tenant_svc.find(self.duplo.tenant_name)
+    return self.tenant
+  
+  def exec(self, subcmd, args=[]):
+    if not (func := getattr(self, subcmd, None)):
+      raise ValueError(f"Invalid subcommand: {subcmd}")
+    try:
+      return print(func(*args))
+    except Exception as e:
+      raise DuploError(f"Error executing subcommand: {subcmd}") from e

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: duplocloud-client
+Version: 0.0.4
+Summary: Generic DuploClient for Python apps.
+Home-page: https://github.com/duplocloud/py-client
+Author: Kelly Ferrone
+Author-email: kelly@duplocloud.net
+Project-URL: Bug Tracker, https://github.com/duplocloud/py-client/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# Duplocloud Py Client  
+
+A package to spawn service clients for working with Duplocloud. 
+
+## Installation  
+
+From PyPi:
+```
+pip install duplocloud-client
+```
+
+From source:
+```
+pip install .
+```
+

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+.coveragerc
+.gitignore
+.gitmodules
+CONTRIBUTING.md
+README.md
+dev-requirements.txt
+pyproject.toml
+setup.cfg
+setup.py
+.github/workflows/publish.yaml
+.github/workflows/test.yml
+src/duplo_resource/__init__.py
+src/duplo_resource/service.py
+src/duplo_resource/tenant.py
+src/duplo_resource/user.py
+src/duplocloud/__init__.py
+src/duplocloud/cli.py
+src/duplocloud/cli_test.py
+src/duplocloud/client.py
+src/duplocloud/errors.py
+src/duplocloud/resource.py
+src/duplocloud_client.egg-info/PKG-INFO
+src/duplocloud_client.egg-info/SOURCES.txt
+src/duplocloud_client.egg-info/dependency_links.txt
+src/duplocloud_client.egg-info/entry_points.txt
+src/duplocloud_client.egg-info/requires.txt
+src/duplocloud_client.egg-info/top_level.txt

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+duploctl = duplocloud.cli:main
+
+[duplocloud.net]
+service = duplo_resource.service:DuploService
+tenant = duplo_resource.tenant:DuploTenant
+user = duplo_resource.user:DuploUser

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests>=2.22.0
+cachetools>=5.2.0

duplocloud-client-0.0.4/src/duplocloud_client.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+duplo_resource
+duplocloud