Skip to main content

Async Python SDK for the Armis API

Project description

pjdev-armis-sdk

PyPI - Version PyPI - Python Version


Async Python SDK for the Armis API, built on httpx and pydantic.

Table of Contents

Installation

pip install pjdev-armis-sdk

Usage

Configure once at startup (reads from environment variables prefixed with ARMIS_):

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:

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 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pjdev_armis_sdk-5.1.9.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pjdev_armis_sdk-5.1.9-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file pjdev_armis_sdk-5.1.9.tar.gz.

File metadata

  • Download URL: pjdev_armis_sdk-5.1.9.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.17.0 {"ci":true,"cpu":"aarch64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.12.76-linuxkit"}} HTTPX2/2.5.0

File hashes

Hashes for pjdev_armis_sdk-5.1.9.tar.gz
Algorithm Hash digest
SHA256 06c41b5e1a2249df753e0e43b5f13cc1e07e5c9a0dcd93c18bf812636e5ee95d
MD5 53322c0a1fa5dde7332a07c488054c99
BLAKE2b-256 242dbe767cd7c8f03826a95b8ea030f06be87e7b0cd13ef8f7df9f413dc4f1f1

See more details on using hashes here.

File details

Details for the file pjdev_armis_sdk-5.1.9-py3-none-any.whl.

File metadata

  • Download URL: pjdev_armis_sdk-5.1.9-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.17.0 {"ci":true,"cpu":"aarch64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.12.76-linuxkit"}} HTTPX2/2.5.0

File hashes

Hashes for pjdev_armis_sdk-5.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4b122a847ceaba1f83a0bd6085af5956735bed2c0f65ffe1d86e438894d2d723
MD5 4da6802acb40cf10c206b71b1adca25e
BLAKE2b-256 19046839f56e74d9c988a6df629f8f4b68b5db6ac8feb02b4fd92ac89490e5cb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page