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.10.tar.gz (11.4 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.10-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.10.tar.gz
  • Upload date:
  • Size: 11.4 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.10.tar.gz
Algorithm Hash digest
SHA256 f0c773025c17b74054c04a892ac10be5789d0999c118b4651fbccee8af92431a
MD5 7b26c26560b77120264b2067652059f0
BLAKE2b-256 fd54a0925bd0ab14b74ae0ebf9d8528503fa73ff8d0b874a913e56c552a8616b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 92e357f9438ae311051bc6bf27c90e61b7936f38327ccbeec1529549c1c97810
MD5 7767b8d53f26b0db433a78e200a73779
BLAKE2b-256 69fc82f470717e0645f12ffd35f59d5a0454883a86d244c1d190eda670c5fdb0

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