xpipe_api 0.1.26__py3-none-any.whl → 0.1.28__py3-none-any.whl

xpipe_api/clients.py

@@ -19,7 +19,7 @@ class Client:
     base_url: str
     raise_errors: bool
     session: Optional[str] = None
-    min_version: Version = Version("10.1-12")
+    min_version: Version = Version("15.2")
 
     def __init__(
         self, token: Optional[str] = None, base_url: Optional[str] = None, ptb: bool = False, raise_errors: bool = True
@@ -36,7 +36,7 @@ class Client:
             except PermissionError:
                 raise NoTokenFoundException("Bad permissions on xpipe_auth: is the daemon running as another user?")
             except Exception as e:
-                raise NoTokenFoundException(f"No auth provided and couldn't load xpipe_auth: {e!r}")
+                raise NoTokenFoundException(f"No auth provided and couldn't load xpipe_auth: {e!r}. Is the XPipe daemon running?")
 
         if not base_url:
             base_url = "http://127.0.0.1:21722" if ptb else "http://127.0.0.1:21721"
@@ -57,11 +57,12 @@ class Client:
         session = response.get("sessionToken", None)
         if session:
             self.session = session
+            daemon_version = self.daemon_version()["version"]
+            assert (
+                    daemon_version == "dev" or Version(daemon_version) >= self.min_version
+            ), f"xpipe_api requires XPipe of at least {self.min_version}"
         else:
             raise AuthFailedException(json.dumps(response))
-        assert (
-            Version(self.daemon_version()["version"]) >= self.min_version
-        ), f"xpipe_api requires XPipe of at least {self.min_version}"
 
     def _post(self, *args, **kwargs) -> requests.Response:
         if not self.session:
@@ -109,7 +110,7 @@ class Client:
     def get(self, *args, **kwargs) -> bytes:
         return self._get(*args, **kwargs).content
 
-    def connection_query(self, categories: str = "*", connections: str = "*", types: str = "*") -> List[str]:
+    def connection_query(self, categories: str = "**", connections: str = "**", types: str = "*") -> List[str]:
         endpoint = f"{self.base_url}/connection/query"
         data = {"categoryFilter": categories, "connectionFilter": connections, "typeFilter": types}
         response = self.post(endpoint, json=data)
@@ -124,12 +125,20 @@ class Client:
         response = self.post(endpoint, json=data)
         return json.loads(response).get("infos", [])
 
-    def connection_add(self, name: str, conn_data: dict, validate: bool = False) -> str:
+    def connection_add(self, name: str, conn_data: dict, validate: bool = False, category: str = None) -> str:
         endpoint = f"{self.base_url}/connection/add"
         data = {"name": name, "data": conn_data, "validate": validate}
+        if category:
+            data["category"] = category
         response = self.post(endpoint, json=data)
         return json.loads(response)["connection"]
 
+    def category_add(self, name: str, parent: str) -> str:
+        endpoint = f"{self.base_url}/category/add"
+        data = {"name": name, "parent": parent}
+        response = self.post(endpoint, json=data)
+        return json.loads(response)["category"]
+
     def connection_remove(self, uuids: Union[str, List[str]]):
         endpoint = f"{self.base_url}/connection/remove"
         if not isinstance(uuids, list):
@@ -161,7 +170,7 @@ class Client:
         data = {"connection": connection}
         self.post(endpoint, json=data)
 
-    def get_connections(self, categories: str = "*", connections: str = "*", types: str = "*") -> List[dict]:
+    def get_connections(self, categories: str = "**", connections: str = "**", types: str = "*") -> List[dict]:
         """Convenience method to chain connection/query with connection/info"""
         uuids = self.connection_query(categories, connections, types)
         return self.connection_info(uuids) if uuids else []
@@ -237,11 +246,13 @@ class AsyncClient(Client):
         session_token = parsed.get("sessionToken", None)
         if session_token:
             self.session = session_token
+            daemon_version = (await self.daemon_version())["version"]
+            assert (
+                    daemon_version == "dev" or Version(daemon_version) >= self.min_version
+            ), f"xpipe_api requires XPipe of at least {self.min_version}"
         else:
             raise AuthFailedException(json.dumps(parsed))
-        assert (
-            Version((await self.daemon_version())["version"]) >= self.min_version
-        ), f"xpipe_api requires XPipe of at least {self.min_version}"
+
 
     async def _post(self, *args, **kwargs) -> aiohttp.ClientResponse:
         if not self.session:
@@ -301,7 +312,7 @@ class AsyncClient(Client):
         resp = await self._get(*args, **kwargs)
         return await resp.read()
 
-    async def connection_query(self, categories: str = "*", connections: str = "*", types: str = "*") -> List[str]:
+    async def connection_query(self, categories: str = "**", connections: str = "**", types: str = "*") -> List[str]:
         endpoint = f"{self.base_url}/connection/query"
         data = {"categoryFilter": categories, "connectionFilter": connections, "typeFilter": types}
         response = await self.post(endpoint, json=data)
@@ -316,12 +327,20 @@ class AsyncClient(Client):
         response = await self.post(endpoint, json=data)
         return json.loads(response).get("infos", [])
 
-    async def connection_add(self, name: str, conn_data: dict, validate: bool = False) -> str:
+    async def connection_add(self, name: str, conn_data: dict, validate: bool = False, category: str = None) -> str:
         endpoint = f"{self.base_url}/connection/add"
         data = {"name": name, "data": conn_data, "validate": validate}
+        if category:
+            data["category"] = category
         response = await self.post(endpoint, json=data)
         return json.loads(response)["connection"]
 
+    async def category_add(self, name: str, parent: str) -> str:
+        endpoint = f"{self.base_url}/category/add"
+        data = {"name": name, "parent": parent}
+        response = await self.post(endpoint, json=data)
+        return json.loads(response)["category"]
+
     async def connection_remove(self, uuids: Union[str, List[str]]):
         endpoint = f"{self.base_url}/connection/remove"
         if not isinstance(uuids, list):
@@ -353,7 +372,7 @@ class AsyncClient(Client):
         data = {"connection": connection}
         await self.post(endpoint, json=data)
 
-    async def get_connections(self, categories: str = "*", connections: str = "*", types: str = "*") -> List[dict]:
+    async def get_connections(self, categories: str = "**", connections: str = "**", types: str = "*") -> List[dict]:
         uuids = await self.connection_query(categories, connections, types)
         return (await self.connection_info(uuids)) if uuids else []
 

xpipe_api-0.1.28.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.3
+Name: xpipe_api
+Version: 0.1.28
+Summary: Client for the XPipe API
+License: MIT
+Author: Clint Olson
+Author-email: coandco@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp-requests (>=0.2.4,<0.3.0)
+Requires-Dist: packaging (>=24.1,<25.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Project-URL: Repository, https://github.com/xpipe-io/xpipe-python-api
+Description-Content-Type: text/markdown
+
+# XPipe Python API
+
+[![GitHub license](https://img.shields.io/github/license/xpipe-io/xpipe-python-api.svg)](https://github.com/xpipe-io/xpipe-python-api/blob/master/LICENSE)
+[![PyPI version](https://img.shields.io/pypi/v/xpipe_api)](https://pypi.org/project/xpipe_api/)
+
+Python client for the XPipe API. This library is a wrapper for the raw [HTTP API](https://github.com/xpipe-io/xpipe/blob/master/openapi.yaml) and intended to make working with it more convenient.
+
+```bash
+python3 -m pip install xpipe_api
+```
+
+You can find the documentation at https://docs.xpipe.io/guide/python-api.
+
+## Development
+
+To run the test suite, you'll need to define the XPIPE_APIKEY env var.  This will allow the two "log in with the ApiKey 
+rather than Local method" tests to work.  Here's the recommended method for running the tests with poetry:
+
+```bash
+cd /path/to/xpipe-python-api
+poetry install
+XPIPE_APIKEY=<api_key> poetry run pytest
+```
+

xpipe_api-0.1.28.dist-info/RECORD

@@ -0,0 +1,7 @@
+xpipe_api/__init__.py,sha256=XLv-a-mt7OcGS9OQbDBHKBsI4mO-4lgWDA13nZ0njFY,108
+xpipe_api/clients.py,sha256=ZbNjpuOSsNtt_ge9XQYxNdYB_zQppBbJOUvg1IFg9Qo,19661
+xpipe_api/exceptions.py,sha256=FdkNKLV1gOH8mOuNM9wH_q3hYNFEdMbQwAEZUX4yZQU,410
+xpipe_api-0.1.28.dist-info/LICENSE,sha256=hWd_i4lSck0lBXcxe-2P4VCUyPAecKW-X1oOiXv21wE,1089
+xpipe_api-0.1.28.dist-info/METADATA,sha256=sOkrtJfXrwEpfYmCW3nsbDI24hUqR8X5tSKH1ZWcKKU,1660
+xpipe_api-0.1.28.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+xpipe_api-0.1.28.dist-info/RECORD,,

{xpipe_api-0.1.26.dist-info → xpipe_api-0.1.28.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 2.0.1
 Root-Is-Purelib: true
 Tag: py3-none-any

xpipe_api-0.1.26.dist-info/METADATA

@@ -1,103 +0,0 @@
-Metadata-Version: 2.1
-Name: xpipe_api
-Version: 0.1.26
-Summary: Client for the XPipe API
-Home-page: https://github.com/xpipe-io/xpipe-python-api
-License: MIT
-Author: Clint Olson
-Author-email: coandco@gmail.com
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aiohttp-requests (>=0.2.4,<0.3.0)
-Requires-Dist: packaging (>=24.1,<25.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Project-URL: Repository, https://github.com/xpipe-io/xpipe-python-api
-Description-Content-Type: text/markdown
-
-# XPipe Python API
-
-[![GitHub license](https://img.shields.io/github/license/xpipe-io/xpipe-python-api.svg)](https://github.com/coandco/python_xpipe_api/blob/master/LICENSE)
-[![PyPI version](https://img.shields.io/pypi/v/xpipe_api)](https://pypi.org/project/xpipe_api/)
-
-Python client for the XPipe API. This library is a wrapper for the raw [HTTP API](https://github.com/xpipe-io/xpipe/blob/master/openapi.yaml) and intended to make working with it more convenient.
-
-## Installation
-```
-python3 -m pip install xpipe_api
-```
-
-## Usage
-
-```python
-from xpipe_api import Client
-
-# By default, Client() will read an access key from the file xpipe_auth on the local filesystem
-# and talk to the XPipe HTTP server on localhost.  To connect to a remote instance with an API
-# key, use Client(token="foo", base_url = "http://servername:21721")
-client = Client()
-
-# connection_query accepts glob-based filters on the category, connection name, and connection type
-all_connections = client.connection_query()
-
-# Each connection includes uuid, category, connection, and type information
-first_connection_uuid = all_connections[0]["uuid"]
-
-# Before any shell commands can be run, a shell session must be started on a connection
-client.shell_start(first_connection_uuid)
-
-# Prints {'exitCode': 0, 'stdout': 'hello world', 'stderr': ''}
-print(client.shell_exec(first_connection_uuid, "echo hello world"))
-
-# Clean up after ourselves by stopping the shell session
-client.shell_stop(first_connection_uuid)
-```
-
-There's also an async version of the client that can be accessed as AsyncClient:
-
-```python
-import asyncio
-from xpipe_api import AsyncClient
-
-
-async def main():
-    # By default, Client() will read an access key from the file xpipe_auth on the local filesystem
-    # and talk to the XPipe HTTP server on localhost.  To connect to a remote instance with an API
-    # key, use Client(token="foo", base_url = "http://servername:21721")
-    client = AsyncClient()
-
-    # connection_query accepts glob-based filters on the category, connection name, and connection type
-    all_connections = await client.connection_query()
-
-    # Each connection includes uuid, category, connection, and type information
-    first_connection_uuid = all_connections[0]["uuid"]
-
-    # Before any shell commands can be run, a shell session must be started on a connection
-    await client.shell_start(first_connection_uuid)
-
-    # Prints {'exitCode': 0, 'stdout': 'hello world', 'stderr': ''}
-    print(await client.shell_exec(first_connection_uuid, "echo hello world"))
-
-    # Clean up after ourselves by stopping the shell session
-    await client.shell_stop(first_connection_uuid)
-
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-This is only a short summary of the library. You can find more supported functionalities in the source itself.
-
-## Tests
-
-To run the test suite, you'll need to define the XPIPE_APIKEY env var.  This will allow the two "log in with the ApiKey 
-rather than Local method" tests to work.  Here's the recommended method for running the tests with poetry:
-
-```commandline
-cd /path/to/python_xpipe_api
-poetry install
-XPIPE_APIKEY=<api_key> poetry run pytest
-```

xpipe_api-0.1.26.dist-info/RECORD

@@ -1,7 +0,0 @@
-xpipe_api/__init__.py,sha256=XLv-a-mt7OcGS9OQbDBHKBsI4mO-4lgWDA13nZ0njFY,108
-xpipe_api/clients.py,sha256=Pg0jyrJpjv8bB0Xo4vdQUiqK3RsLdlAmJXorJLNBwhw,18740
-xpipe_api/exceptions.py,sha256=FdkNKLV1gOH8mOuNM9wH_q3hYNFEdMbQwAEZUX4yZQU,410
-xpipe_api-0.1.26.dist-info/LICENSE,sha256=hWd_i4lSck0lBXcxe-2P4VCUyPAecKW-X1oOiXv21wE,1089
-xpipe_api-0.1.26.dist-info/METADATA,sha256=EMi4uQvxYDAw6jGDTK_ViCmUzgb9BNOZVeqyJbwIGvY,3900
-xpipe_api-0.1.26.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-xpipe_api-0.1.26.dist-info/RECORD,,