pjdev-armis-sdk 5.1.4__tar.gz

pjdev_armis_sdk-5.1.4/.gitignore

@@ -0,0 +1,168 @@
+.DS_Store
+.idea
+
+!**/.gitkeep
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+**/uv.lock
+!./uv.lock

pjdev_armis_sdk-5.1.4/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026-present Chris O'Neill <chris@purplejay.io>
+
+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.

pjdev_armis_sdk-5.1.4/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: pjdev-armis-sdk
+Version: 5.1.4
+Summary: Async Python SDK for the Armis API
+Project-URL: Documentation, https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-armis-sdk/README.md
+Project-URL: Issues, https://gitlab.purplejay.io/keystone/python/-/issues
+Project-URL: Source, https://gitlab.purplejay.io/keystone/python
+Author-email: Purple Jay LLC <developers@purplejay.io>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Requires-Dist: httpx
+Requires-Dist: loguru
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: pydantic>=2.12.5
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: respx; extra == 'test'
+Description-Content-Type: text/markdown
+
+# pjdev-armis-sdk
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-armis-sdk.svg)](https://pypi.org/project/pjdev-armis-sdk)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-armis-sdk.svg)](https://pypi.org/project/pjdev-armis-sdk)
+
+-----
+
+Async Python SDK for the [Armis](https://www.armis.com/) API, built on `httpx` and `pydantic`.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+```console
+pip install pjdev-armis-sdk
+```
+
+## Usage
+
+Configure once at startup (reads from environment variables prefixed with `ARMIS_`):
+
+```python
+from pjdev_armis_sdk import config_service
+
+config_service.init(
+    instance_url="https://your-tenant.armis.com",
+    secret_key="your-secret-key",
+)
+```
+
+Then call any of the resource modules:
+
+```python
+from pjdev_armis_sdk import devices, search
+
+# AQL search
+result = await search.aql_search("in:devices type:MOBILE_PHONE")
+
+# Lookup a single device by id
+device = await devices.get_device(id=12345)
+```
+
+Auth (`Authorization` header with a temporary access token) is handled automatically
+by the underlying `httpx.AsyncClient`. Tokens are refreshed on the fly when they expire
+or when the API returns 401.
+
+## License
+
+`pjdev-armis-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_armis_sdk-5.1.4/README.md

@@ -0,0 +1,53 @@
+# pjdev-armis-sdk
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-armis-sdk.svg)](https://pypi.org/project/pjdev-armis-sdk)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-armis-sdk.svg)](https://pypi.org/project/pjdev-armis-sdk)
+
+-----
+
+Async Python SDK for the [Armis](https://www.armis.com/) API, built on `httpx` and `pydantic`.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+```console
+pip install pjdev-armis-sdk
+```
+
+## Usage
+
+Configure once at startup (reads from environment variables prefixed with `ARMIS_`):
+
+```python
+from pjdev_armis_sdk import config_service
+
+config_service.init(
+    instance_url="https://your-tenant.armis.com",
+    secret_key="your-secret-key",
+)
+```
+
+Then call any of the resource modules:
+
+```python
+from pjdev_armis_sdk import devices, search
+
+# AQL search
+result = await search.aql_search("in:devices type:MOBILE_PHONE")
+
+# Lookup a single device by id
+device = await devices.get_device(id=12345)
+```
+
+Auth (`Authorization` header with a temporary access token) is handled automatically
+by the underlying `httpx.AsyncClient`. Tokens are refreshed on the fly when they expire
+or when the API returns 401.
+
+## License
+
+`pjdev-armis-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_armis_sdk-5.1.4/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pjdev-armis-sdk"
+dynamic = ["version"]
+description = 'Async Python SDK for the Armis API'
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Purple Jay LLC", email = "developers@purplejay.io" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "httpx",
+  "loguru",
+  "pydantic-settings>=2.13.1",
+  "pydantic>=2.12.5",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+]
+
+test = [
+    "pytest",
+    "pytest-asyncio",
+    "coverage",
+    "respx",
+]
+
+[project.urls]
+Documentation = "https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-armis-sdk/README.md"
+Issues = "https://gitlab.purplejay.io/keystone/python/-/issues"
+Source = "https://gitlab.purplejay.io/keystone/python"
+
+[tool.hatch.version]
+path = "src/pjdev_armis_sdk/__about__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pjdev_armis_sdk"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/pjdev_armis_sdk/py.typed" = "pjdev_armis_sdk/py.typed"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/pjdev_armis_sdk",
+  "README.md",
+  "LICENSE.txt",
+]
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/pjdev_armis_sdk tests}"
+
+[tool.coverage.run]
+source_pkgs = ["pjdev_armis_sdk", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/pjdev_armis_sdk/__about__.py",
+]
+
+[tool.coverage.paths]
+pjdev_armis_sdk = ["src/pjdev_armis_sdk", "*/pjdev-armis-sdk/src/pjdev_armis_sdk"]
+tests = ["tests", "*/pjdev-armis-sdk/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

pjdev_armis_sdk-5.1.4/src/pjdev_armis_sdk/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2026-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "5.1.4"

pjdev_armis_sdk-5.1.4/src/pjdev_armis_sdk/__init__.py

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2026-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT
+
+from pjdev_armis_sdk import (
+    access_token,
+    api_utilities,
+    boundaries,
+    config_service,
+    devices,
+    http_client,
+    integrations,
+    models,
+    search,
+    sites,
+    users,
+)
+
+__all__ = [
+    "access_token",
+    "api_utilities",
+    "boundaries",
+    "config_service",
+    "devices",
+    "http_client",
+    "integrations",
+    "models",
+    "search",
+    "sites",
+    "users",
+]

pjdev_armis_sdk-5.1.4/src/pjdev_armis_sdk/_internal.py

@@ -0,0 +1,32 @@
+from contextlib import asynccontextmanager
+from typing import Any, AsyncIterator, Awaitable, Callable, Optional, TypeVar
+
+import httpx
+
+from pjdev_armis_sdk.http_client import http_client
+
+T = TypeVar("T")
+
+
+@asynccontextmanager
+async def _resolve_client(
+    client: Optional[httpx.AsyncClient],
+) -> AsyncIterator[httpx.AsyncClient]:
+    if client is not None:
+        yield client
+        return
+    async with http_client() as _client:
+        yield _client
+
+
+async def with_client(
+    client: Optional[httpx.AsyncClient],
+    fn: Callable[[httpx.AsyncClient], Awaitable[T]],
+) -> T:
+    """Run `fn` against either the caller-provided client or a fresh one."""
+    async with _resolve_client(client) as c:
+        return await fn(c)
+
+
+def drop_none(params: dict[str, Any]) -> dict[str, Any]:
+    return {k: v for k, v in params.items() if v is not None}

pjdev_armis_sdk-5.1.4/src/pjdev_armis_sdk/access_token.py

@@ -0,0 +1,37 @@
+from typing import Optional
+
+import httpx
+
+from pjdev_armis_sdk.api_utilities import async_retry_http
+from pjdev_armis_sdk.config_service import get_config
+from pjdev_armis_sdk.models import ArmisAccessTokenResponse, ArmisTokenData
+
+
+@async_retry_http(status_codes_to_ignore=[400, 401, 403])
+async def get_access_token(
+    secret_key: Optional[str] = None,
+) -> ArmisTokenData:
+    """
+    Exchange a secret_key for a temporary Armis access token.
+
+    This is normally handled automatically by `ArmisAccessTokenAuth` on the shared
+    `httpx.AsyncClient`. Call this directly only when you need the raw token (e.g.
+    for inspection, or to pass to a non-SDK consumer).
+    """
+    config = get_config()
+    key = secret_key or config.secret_key
+    if not key:
+        raise ValueError("secret_key not provided and not configured")
+    if not config.instance_url:
+        raise ValueError("instance_url not configured")
+
+    async with httpx.AsyncClient(
+        base_url=config.instance_url,
+        timeout=config.request_timeout_seconds,
+    ) as client:
+        r = await client.post(
+            "/api/v1/access_token/",
+            data={"secret_key": key},
+        )
+        r.raise_for_status()
+        return ArmisAccessTokenResponse.model_validate(r.json()).data

pjdev_armis_sdk-5.1.4/src/pjdev_armis_sdk/api_utilities.py

@@ -0,0 +1,110 @@
+import asyncio
+import time
+from functools import wraps
+from typing import Any, Awaitable, Callable, List, Optional, ParamSpec, TypeVar
+
+import httpx
+from httpx import ConnectError, HTTPStatusError
+from loguru import logger
+
+from pjdev_armis_sdk.config_service import get_config
+
+P = ParamSpec("P")
+R = TypeVar("R")
+
+
+async def log_request_headers(request: httpx.Request) -> None:
+    logger.debug(f"Request: {request.method} {request.url}")
+
+
+async def log_response_headers(response: httpx.Response) -> None:
+    logger.debug(
+        f"Response: {response.request.method} {response.request.url} -> {response.status_code}"
+    )
+
+
+def async_retry_http(
+    default_value: Optional[Any] = None,
+    status_codes_to_ignore: Optional[List[int]] = None,
+) -> Callable[[Callable[P, Awaitable[R]]], Callable[P, Awaitable[R]]]:
+    def decorator(func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]:
+        @wraps(func)
+        async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+            config = get_config()
+            max_attempts = config.http_retry_max_count
+            delay_seconds = config.http_retry_delay_seconds
+            attempts = 0
+            exceptions: List[Exception] = []
+
+            while attempts < max_attempts:
+                try:
+                    return await func(*args, **kwargs)
+                except HTTPStatusError as e:
+                    logger.warning(
+                        f"{e.response.status_code}: {e.response.reason_phrase} - {e.response.text}"
+                    )
+                    exceptions.append(e)
+                    if (
+                        status_codes_to_ignore
+                        and e.response.status_code in status_codes_to_ignore
+                    ):
+                        break
+                except ConnectError as e:
+                    logger.warning(f"{e.request.url} not reachable")
+                    exceptions.append(e)
+
+                attempts += 1
+                if attempts == max_attempts:
+                    break
+                total_delay = delay_seconds**attempts
+                logger.warning(
+                    f"Attempt {attempts}/{max_attempts} failed. Retrying in {total_delay} seconds..."
+                )
+                await asyncio.sleep(total_delay)
+
+            if default_value is None:
+                raise ExceptionGroup(
+                    f"Failed after {max_attempts} attempts", exceptions
+                )
+            logger.error(f"Failed after {max_attempts} attempts")
+            return default_value
+
+        return wrapper
+
+    return decorator
+
+
+def record_time(
+    log: bool = False,
+) -> Callable[[Callable[P, R]], Callable[P, R]]:
+    def decorator(func: Callable[P, R]) -> Callable[P, R]:
+        if asyncio.iscoroutinefunction(func):
+
+            @wraps(func)
+            async def wrap_func_async(*args: P.args, **kwargs: P.kwargs) -> Any:
+                t1 = time.time()
+                result = await func(*args, **kwargs)
+                t2 = time.time()
+                if log:
+                    logger.info(
+                        f"Function {func.__name__!r} executed in {(t2 - t1):.2f}s"
+                    )
+                return result
+
+            return wrap_func_async  # type: ignore[return-value]
+
+        @wraps(func)
+        def wrap_func(*args: P.args, **kwargs: P.kwargs) -> R:
+            t1 = time.time()
+            result = func(*args, **kwargs)
+            t2 = time.time()
+            if log:
+                logger.info(
+                    f"Function {func.__name__!r} executed in {(t2 - t1):.2f}s"
+                )
+
+            return result
+
+        return wrap_func
+
+    return decorator