ubersmith-api 1.0.0__tar.gz

ubersmith_api-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ben Nassif
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ubersmith_api-1.0.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: ubersmith-api
+Version: 1.0.0
+Summary: Version-specific Python 3 wrapper for the Ubersmith API
+Author-email: Ben Nassif <bennassif@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/bnassif/ubersmith-api
+Project-URL: issues, https://github.com/bnassif/ubersmith-api/issues
+Keywords: api,wrapper,ubersmith,client
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=1.0.4
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pydantic>=2.5.2
+Provides-Extra: build
+Requires-Dist: jinja2; extra == "build"
+Dynamic: license-file
+
+# Python Ubersmith
+[![Pypi](https://img.shields.io/pypi/v/ubersmith-api)](https://pypi.org/project/ubersmith-api)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/bnassif/ubersmith-api/main/LICENSE)
+![GitHub Release Date](https://img.shields.io/github/release-date/bnassif/ubersmith-api)
+
+A fully-featured API wrapper for the [Ubersmith](https://ubersmith.com/) API
+
+Python wrappers exist on PyPI and across GitHub for interacting with the Ubersmith API, but each of them fails to provide full compatibility.
+
+In comes `ubersmith-api`...
+
+## Overview
+
+At its core, this package provides a generic API wrapper class, `UbersmithClient` which allows for uncontrolled calls to an Ubersmith instance.
+
+Built atop this wrapper, a templating suite is available for generating classes for each API section in Ubersmith, specific to each Ubersmith version to maximize compatibility.
+
+## Installation
+
+```bash
+# PyPi Installation
+pip install ubersmith-api
+# GitHub Installation
+pip install git+'https://github.com/bnassif/ubersmith-api.git'
+```
+
+## Getting Started
+
+### Instantiating the Base Client
+```python
+from ubersmith_api import *
+
+config = UbersmithConfig(
+    host='target-hostname-or-address',
+    username='username-to-use',
+    password='api-token-for-user',
+)
+
+client = UbersmithClient(config)
+```
+
+### Making Calls
+
+```python
+response_obj = client.request(
+    'uber.method_get',
+    data={
+        'method_name': 'client.get',
+    },
+    #raw=True,
+)
+```
+
+By default, the `request()` method will parse the response from the API, checking for HTTP error codes, as well as error messages from Ubersmith itself. If no errors are found, the returned `data` field is returned.
+
+Alternatively, you can parse `raw=True` to return the `requests.Response` object for manual parsing and error checking.
+
+### Shipped Methods
+The `UbersmithClient` class comes with three (3) core methods shipped.  
+These offer a simplified entrypoint to gathering parsed information of an Ubersmith system.
+
+```python
+# Get system information: calls `uber.system_info`
+sys_info = client.system_info()
+
+# Get all available methods: calls `uber.method_list`
+all_methods = client.method_list()
+
+# Get details of one method: calls `uber.method_get`
+method_details = client.method_get('client.get')
+```
+
+## Future Compatibility
+
+**NOTE**: 
+
+Additional code is shipped in this repository, along with version-specific schemas for the Ubersmith API.  
+These features will be enabled in later releases of the package.
+
+## License
+MIT - Feel free to use, extend, and contribute.

ubersmith_api-1.0.0/README.md

@@ -0,0 +1,81 @@
+# Python Ubersmith
+[![Pypi](https://img.shields.io/pypi/v/ubersmith-api)](https://pypi.org/project/ubersmith-api)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/bnassif/ubersmith-api/main/LICENSE)
+![GitHub Release Date](https://img.shields.io/github/release-date/bnassif/ubersmith-api)
+
+A fully-featured API wrapper for the [Ubersmith](https://ubersmith.com/) API
+
+Python wrappers exist on PyPI and across GitHub for interacting with the Ubersmith API, but each of them fails to provide full compatibility.
+
+In comes `ubersmith-api`...
+
+## Overview
+
+At its core, this package provides a generic API wrapper class, `UbersmithClient` which allows for uncontrolled calls to an Ubersmith instance.
+
+Built atop this wrapper, a templating suite is available for generating classes for each API section in Ubersmith, specific to each Ubersmith version to maximize compatibility.
+
+## Installation
+
+```bash
+# PyPi Installation
+pip install ubersmith-api
+# GitHub Installation
+pip install git+'https://github.com/bnassif/ubersmith-api.git'
+```
+
+## Getting Started
+
+### Instantiating the Base Client
+```python
+from ubersmith_api import *
+
+config = UbersmithConfig(
+    host='target-hostname-or-address',
+    username='username-to-use',
+    password='api-token-for-user',
+)
+
+client = UbersmithClient(config)
+```
+
+### Making Calls
+
+```python
+response_obj = client.request(
+    'uber.method_get',
+    data={
+        'method_name': 'client.get',
+    },
+    #raw=True,
+)
+```
+
+By default, the `request()` method will parse the response from the API, checking for HTTP error codes, as well as error messages from Ubersmith itself. If no errors are found, the returned `data` field is returned.
+
+Alternatively, you can parse `raw=True` to return the `requests.Response` object for manual parsing and error checking.
+
+### Shipped Methods
+The `UbersmithClient` class comes with three (3) core methods shipped.  
+These offer a simplified entrypoint to gathering parsed information of an Ubersmith system.
+
+```python
+# Get system information: calls `uber.system_info`
+sys_info = client.system_info()
+
+# Get all available methods: calls `uber.method_list`
+all_methods = client.method_list()
+
+# Get details of one method: calls `uber.method_get`
+method_details = client.method_get('client.get')
+```
+
+## Future Compatibility
+
+**NOTE**: 
+
+Additional code is shipped in this repository, along with version-specific schemas for the Ubersmith API.  
+These features will be enabled in later releases of the package.
+
+## License
+MIT - Feel free to use, extend, and contribute.

ubersmith_api-1.0.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "ubersmith-api"
+authors = [
+    { name="Ben Nassif", email="bennassif@gmail.com" }
+]
+
+dynamic = ["version"]
+
+description = "Version-specific Python 3 wrapper for the Ubersmith API"
+readme = "README.md"
+
+requires-python = ">=3.10"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = [
+    "api", "wrapper", "ubersmith", "client"
+]
+
+license = "MIT"
+license-files = [
+    "LICEN[CS]E"
+]
+
+dependencies = [
+    "requests >= 1.0.4",
+    "pydantic-settings >= 2.1.0",
+    "pydantic >= 2.5.2",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "ubersmith.__version__.__version__" }
+
+[project.urls]
+homepage = "https://github.com/bnassif/ubersmith-api"
+issues = "https://github.com/bnassif/ubersmith-api/issues"
+
+[project.optional-dependencies]
+build = [
+    "jinja2",
+]

ubersmith_api-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ubersmith_api-1.0.0/src/ubersmith/__init__.py

@@ -0,0 +1,5 @@
+from .__version__ import (
+    __version__,
+    __license__,
+)
+from ubersmith.client import *

ubersmith_api-1.0.0/src/ubersmith/__version__.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.0"
+__license__ = "MIT"

ubersmith_api-1.0.0/src/ubersmith/api/core.py

@@ -0,0 +1,96 @@
+from ubersmith.client.api import *
+import inspect
+
+__all__ = [
+    'UbersmithClient',
+    'UbersmithConfig',
+    'Section',
+]
+
+class Section:
+    """
+    Base API Section Class
+    
+    This class is used to represent an API section in the Ubersmith API. It's a simple entry to binding
+    a client to an arbitrary class, which will then have methods which call on the bound client.
+    """
+    _client: UbersmithClient
+    
+    def __init__(self, client: UbersmithClient = None, config: UbersmithConfig = None):
+        """Instantiate a Client Section by binding a client to it.
+        
+        If a client is not supplied, attempt loading the configuration from the environment
+        and binding a client bound to that configuration instead. Optionally, provide a configuration
+        instead of a client.
+        
+        An error will be thrown if both a client and config are supplied.
+
+        Args:
+            client (UbersmithClient, optional): The client to bind to the class. Defaults to None.
+            config (UbersmithConfig, optional): The config to instantiate a client from to bind to the class. Defaults to None.
+
+        Raises:
+            Exception: A base Exception is raised when both a client and config are supplied
+        """
+        if config and client:
+            raise Exception("Both a client and config cannot be supplied")
+        
+        if client:
+            # Bind the client, if supplied
+            self._client = client
+        else:
+            # Binds a supplied config, or allows the underlying client to instantiate one
+            self._client = UbersmithClient(config=config)
+    
+    def _get_parameters(self, method, inputs: dict) -> dict:
+        """Returns the Signature of the target Method
+        
+        This method is used to simplify how parameters in a method are passed to the underlying client
+        as keyword arguments to reduce templating/development work needed.
+
+        Args:
+            method (method): The method to inspect
+        
+        Returns:
+            dict: The dictionary of *args **kwargs passed to a method
+        """
+        data = {}
+        meta = None
+        # Get the parameters of the provided method
+        params = list(inspect.signature(method).parameters.keys())
+        
+        # If meta is in the parameters, remove it prior to looping
+        # We'll add these with Ubersmith's desired structure after handlilng the initial bit
+        if 'meta' in params:
+            # Get the meta inputs separate from the rest
+            meta = inputs.pop('meta')
+            # Remove meta from the params to inspect
+            params.remove('meta')
+                
+        for p in params:
+            data.update({p: inputs[p]})
+        
+        if meta:
+            # If meta is supplied, add those under the `meta_` arguments
+            for k, v in meta.items():
+                data.update({f'meta_{k}': v})
+                
+        return data
+    
+    def _get_section_name(self):
+        return self.__class__.__name__.rstrip('API').lower()
+    
+    def _request(self, method, inputs):
+        """Sends a request using the underlying client
+        
+        This method takes the calling method at the first parameter to perform inspection on it.
+        Locals are also passed from the calling parameter so they can be formed and passed to the API.
+
+        Args:
+            method (method): The calling method, passed through raw
+            data (dict, optional): _description_. Defaults to None.
+        """
+        data = self._get_parameters(method, inputs)
+        command=f'{self._get_section_name()}.{method.__name__}'
+        
+        return self._client.request(command, data=data, parsed=True)

ubersmith_api-1.0.0/src/ubersmith/client/__init__.py

@@ -0,0 +1,6 @@
+from ubersmith.client.api import *
+
+__all__ = [
+    'UbersmithConfig',
+    'UbersmithClient',
+]

ubersmith_api-1.0.0/src/ubersmith/client/api.py

@@ -0,0 +1,42 @@
+from ubersmith.client.base import *
+
+__all__ = [
+    'UbersmithConfig',
+    'UbersmithClient',
+]
+
+class UbersmithClient(BaseClient):
+    """
+    API Client for the Ubersmith API
+    
+    Args:
+        config (UbersmithConfig): The configuration object for the client.
+    """
+    
+    def method_list(self) -> dict:
+        """
+        Lists all methods available in the target Ubersmith instance.
+        This is the `data` field as returned by `uber.method_list`
+        
+        Returns:
+            list[dict]: The list of methods available in the instance. Keys are the methods/commands and values are short descriptions.
+        """
+        return self.request('uber.method_list')
+    
+    def method_get(self, method_name: str) -> dict:
+        """
+        Gets the details of a specific API method.
+
+        Args:
+            method_name (str): The method name to gather details on (i.e. `uber.method_get`)
+        """
+        return self.request('uber.method_get', data={'method_name': method_name})
+    
+    def system_info(self) -> dict:
+        """
+        Gets the Ubersmith service version and latest version available
+
+        Returns:
+            dict: The response dictionary containing the version and latest_version
+        """
+        return self.request('uber.system_info')

ubersmith_api-1.0.0/src/ubersmith/client/base.py

@@ -0,0 +1,74 @@
+import requests
+import urllib3
+
+from ubersmith.config import UbersmithConfig
+from ubersmith.util.cleaners import *
+from ubersmith.util.parse import parse_response
+from ubersmith.util.files import get_files
+
+__all__ = [
+    'UbersmithConfig',
+    'BaseClient',
+]
+
+class BaseClient:
+    """
+    API Client for the Ubersmith API
+    
+    Args:
+        config (Config): The configuration object for the client.
+    """
+    
+    def __init__(self, config: UbersmithConfig = None):
+        """
+        Initialize the client with the provided config.
+        If a config is not supplied, attempt loading one from the environment.
+        
+
+        Args:
+            config (Config, optional): The Config to bind to the client. If not supplied, one is loaded from the environment.
+        """
+        self.config = config if config else UbersmithConfig()
+    
+    def request(self, command: str, data: dict = None, files: dict = None, raw: bool = False) -> requests.Response:
+        """
+        Makes a request to the Ubersmith API
+        
+        Args:
+            command (str): The Ubersmith API command to call
+            data (dict, optional): The POST data to send in the request. Defaults to None.
+
+        Returns:
+            requests.Response: The resposne from the Ubersmith API
+        """
+        
+        if not self.config.verify:
+            urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        
+        # Clean input data, if provided
+        if data:
+            clean_all(data)
+        
+        tries = 0
+        for _ in range(tries, self.config.api_tries):
+            try:
+                response = requests.post(
+                    # API URL of the request
+                    url=f"{self.config.api_url}/?method={command}",
+                    # Pass through data, if supplied
+                    data=data,
+                    # Attach files, if supplied
+                    files=get_files(files),
+                    # Add basic authentication using the user/pass
+                    auth=(self.config.username, self.config.password),
+                    # Add the timeout from the config
+                    timeout=self.config.api_timeout,
+                    verify=self.config.verify,
+                )
+                if not raw:
+                    return parse_response(response)
+                return response
+            except requests.exceptions.Timeout:
+                # Increment the tries counter and continue remaining attempts
+                tries += 1
+                continue

ubersmith_api-1.0.0/src/ubersmith/config.py

@@ -0,0 +1,101 @@
+from pathlib import Path
+
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from os import getenv
+
+__all__ = [
+    'UbersmithConfig',
+]
+
+# Set the default .env file path -- this can be overridden upon instantiation with _env_file=<path>
+default_dotenv_path = Path(
+    getenv(
+        key='UBERSMITH_API_ENV_FILE',  # Allows users to specify an env variable for the config file
+        default=f"{str(Path.home())}/.ubersmith.env")  # Defaults to a home directory config file
+)
+
+
+class UbersmithConfig(BaseSettings):
+    """
+    A class to hold the configuration settings for the PowerDNS API client.
+    """
+    model_config = SettingsConfigDict(
+        case_sensitive=False,
+        env_prefix='UBERSMITH_',
+        env_file=default_dotenv_path.resolve(),
+    )
+    
+    username: str = Field(
+        title="API Username",
+        description="The API username to authenticate with.",
+        repr=False
+    )
+    
+    password: str = Field(
+        title="API Password",
+        description="The API password for the API Username.",
+        repr=False,
+    )
+    
+    host: str = Field(
+        title="API Host",
+        description="The IP address or hostname of the API server to connect to.",
+        default='localhost'
+    )
+    port: int = Field(
+        title="API Port",
+        description="The Port number of the API server to connect to.",
+        ge=1, le=65535, default=443
+    )
+    secure: bool = Field(
+        title="HTTP Security",
+        description="Whether to make secure (HTTPS) or insecure (HTTP) requests",
+        default=True,
+    )
+    version: str = Field(
+        title="API Version",
+        description="The PowerDNS API verion to use.",
+        default='2.0', repr=False
+    )
+    verify: bool = Field(
+        title="Verify Certificate",
+        description="Whether to verify the server certificate if secure is True",
+        default=True,        
+    )
+
+    # API Client Settings
+    api_delay: float = Field(
+        title="API Delay",
+        description="The time to wait between retries.",
+        gt=0, le=60, default=15, repr=False
+    )
+    api_timeout: int = Field(
+        title="API Timeout",
+        description="The time to wait for a response after making a request before failing.",
+        ge=1, le=900, default=30, repr=False
+    )
+    api_tries: int = Field(
+        title="API Retries",
+        description="The amount of times to (re)attempt call before failing.",
+        gt=0, le=25, default=1, repr=False
+    )
+    
+    @property
+    def _schema(self):
+        if self.secure:
+            return 'https'
+        return 'http'
+
+    @property
+    def api_url(self):
+        return f"{self._schema}://{self.host}:{self.port}/api/{self.version}"
+
+    def update(self, data: dict = None, **kwargs):
+        if data and not isinstance(data, dict):
+            raise RuntimeError(f'Input data must be a dict. Received: {data}')
+        elif kwargs and not data:
+            data = kwargs
+        elif kwargs and data:
+            data.update(kwargs)
+        self.__dict__.update(data)

ubersmith_api-1.0.0/src/ubersmith/util/cleaners.py

@@ -0,0 +1,48 @@
+def bool_to_int(data: dict):
+    """
+    Converts boolean values in a dict to integers for parsing by the Ubersmith API
+
+    Args:
+        data (dict): The dict you want cleaned
+    """
+    for k, v in data.items():
+        # Handle all sub-items recursively
+        if isinstance(v, dict):
+            bool_to_int(v)
+        # Convert any boolean inputs to integers
+        elif isinstance(v, bool):
+            data[k] = int(v)
+
+def passwd_to_pass(data: dict):
+    """
+    Converts the `passwd` keyword argument to `pass` as required by the API
+    
+    This allows circumventing conflicts with the keyword argument pass and Python's pass directive
+
+    Args:
+        data (dict): The dict you want cleaned
+    """
+    for k in data.keys():
+        if k == 'passwd':
+            data['pass'] = data.pop(k)
+
+def from_address_to_from(data: dict):
+    for k in data.keys():
+        if k == 'from_address':
+            data['from'] = data.pop(k)
+
+
+def clean_all(data: dict):
+    """
+    Runs all cleaners against inputs
+
+    Args:
+        data (dict): The dict you want cleaned
+    """
+    cleaners = [
+        bool_to_int,
+        passwd_to_pass,
+        from_address_to_from,
+    ]
+    for c in cleaners:
+        c(data)

ubersmith_api-1.0.0/src/ubersmith/util/exceptions.py

@@ -0,0 +1,19 @@
+# ubersmith/util/exceptions.py
+
+# This module contains the core Exception class that is used to wrap error responses from
+# the Ubersmith API. This includes the error_code and error_message as provided from the API
+
+__all__ = [
+    'UbersmithException',
+]
+
+class UbersmithException(Exception):
+    def __init__(self, error_code: int, error_message: str):
+        self.error_code = error_code
+        self.error_message = error_message
+        # Pass a formatted string up to the base Exception
+        super().__init__(f"{error_code}; {error_message}")
+
+    def __str__(self):
+        # Controls how it prints when raised
+        return f"UbersmithException: {self.error_code}; {self.error_message}"

ubersmith_api-1.0.0/src/ubersmith/util/files.py

@@ -0,0 +1,16 @@
+__all__ = [
+    'get_files',
+]
+
+def get_files(attachments: dict):
+    if not attachments:
+        return None
+    files = dict()
+    for k, v in attachments.items():
+        if type(v) is str:
+            files[k] = open(v, 'rb')
+        elif type(v) is bytes:
+            files[k] = v
+        else:
+            raise Exception(f'Invalid attachment {k}: Type {type(v)}')
+    return files

ubersmith_api-1.0.0/src/ubersmith/util/parse.py

@@ -0,0 +1,41 @@
+# ubersmith.util.parse.py
+import requests
+from typing import Union
+
+from ubersmith.util.exceptions import UbersmithException
+
+__all__ = [
+    'parse_response',
+]
+
+# This module contains the items needed for parsing objects from Ubersmith's API in a centralized
+# manner. This is imported into ubersmith.core.api.py for the `APIClient.request_parsed()` method
+
+def parse_response(response: requests.Response) -> Union[dict|list]:
+    """
+    Parse a response from the returned `requests.Reponse` object per Ubersmith's API structure
+
+    Args:
+        response (requests.Response): The response from the Ubersmith API
+
+    Returns:
+        Union[dict|list]: The nested `data` field in the response, if returned
+    Raises:
+        ubersmith.core.exceptions.UbersmithException: Raised when the response has an error
+    """
+    
+    # Base HTTP response exceptions
+    response.raise_for_status()
+    
+    # Gather the response body from the Response object
+    body = response.json()
+    
+    # Raise UbersmithException if the status is not successful
+    if not body['status']:
+        raise UbersmithException(
+            error_code=int(body['error_code']),
+            error_message=str(body['error_message']),
+        )
+    
+    # Otherwise, return the `data` field from the body
+    return body['data']

ubersmith_api-1.0.0/src/ubersmith_api.egg-info/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: ubersmith-api
+Version: 1.0.0
+Summary: Version-specific Python 3 wrapper for the Ubersmith API
+Author-email: Ben Nassif <bennassif@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/bnassif/ubersmith-api
+Project-URL: issues, https://github.com/bnassif/ubersmith-api/issues
+Keywords: api,wrapper,ubersmith,client
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=1.0.4
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pydantic>=2.5.2
+Provides-Extra: build
+Requires-Dist: jinja2; extra == "build"
+Dynamic: license-file
+
+# Python Ubersmith
+[![Pypi](https://img.shields.io/pypi/v/ubersmith-api)](https://pypi.org/project/ubersmith-api)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/bnassif/ubersmith-api/main/LICENSE)
+![GitHub Release Date](https://img.shields.io/github/release-date/bnassif/ubersmith-api)
+
+A fully-featured API wrapper for the [Ubersmith](https://ubersmith.com/) API
+
+Python wrappers exist on PyPI and across GitHub for interacting with the Ubersmith API, but each of them fails to provide full compatibility.
+
+In comes `ubersmith-api`...
+
+## Overview
+
+At its core, this package provides a generic API wrapper class, `UbersmithClient` which allows for uncontrolled calls to an Ubersmith instance.
+
+Built atop this wrapper, a templating suite is available for generating classes for each API section in Ubersmith, specific to each Ubersmith version to maximize compatibility.
+
+## Installation
+
+```bash
+# PyPi Installation
+pip install ubersmith-api
+# GitHub Installation
+pip install git+'https://github.com/bnassif/ubersmith-api.git'
+```
+
+## Getting Started
+
+### Instantiating the Base Client
+```python
+from ubersmith_api import *
+
+config = UbersmithConfig(
+    host='target-hostname-or-address',
+    username='username-to-use',
+    password='api-token-for-user',
+)
+
+client = UbersmithClient(config)
+```
+
+### Making Calls
+
+```python
+response_obj = client.request(
+    'uber.method_get',
+    data={
+        'method_name': 'client.get',
+    },
+    #raw=True,
+)
+```
+
+By default, the `request()` method will parse the response from the API, checking for HTTP error codes, as well as error messages from Ubersmith itself. If no errors are found, the returned `data` field is returned.
+
+Alternatively, you can parse `raw=True` to return the `requests.Response` object for manual parsing and error checking.
+
+### Shipped Methods
+The `UbersmithClient` class comes with three (3) core methods shipped.  
+These offer a simplified entrypoint to gathering parsed information of an Ubersmith system.
+
+```python
+# Get system information: calls `uber.system_info`
+sys_info = client.system_info()
+
+# Get all available methods: calls `uber.method_list`
+all_methods = client.method_list()
+
+# Get details of one method: calls `uber.method_get`
+method_details = client.method_get('client.get')
+```
+
+## Future Compatibility
+
+**NOTE**: 
+
+Additional code is shipped in this repository, along with version-specific schemas for the Ubersmith API.  
+These features will be enabled in later releases of the package.
+
+## License
+MIT - Feel free to use, extend, and contribute.

ubersmith_api-1.0.0/src/ubersmith_api.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+src/ubersmith/__init__.py
+src/ubersmith/__version__.py
+src/ubersmith/config.py
+src/ubersmith/api/core.py
+src/ubersmith/client/__init__.py
+src/ubersmith/client/api.py
+src/ubersmith/client/base.py
+src/ubersmith/util/__init__.py
+src/ubersmith/util/cleaners.py
+src/ubersmith/util/exceptions.py
+src/ubersmith/util/files.py
+src/ubersmith/util/parse.py
+src/ubersmith_api.egg-info/PKG-INFO
+src/ubersmith_api.egg-info/SOURCES.txt
+src/ubersmith_api.egg-info/dependency_links.txt
+src/ubersmith_api.egg-info/requires.txt
+src/ubersmith_api.egg-info/top_level.txt

ubersmith_api-1.0.0/src/ubersmith_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ubersmith_api-1.0.0/src/ubersmith_api.egg-info/requires.txt

@@ -0,0 +1,6 @@
+requests>=1.0.4
+pydantic-settings>=2.1.0
+pydantic>=2.5.2
+
+[build]
+jinja2

ubersmith_api-1.0.0/src/ubersmith_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+ubersmith