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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.7.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for pjdev_armis_sdk-5.1.7.tar.gz
Algorithm Hash digest
SHA256 024995b8daa16c18d6aec9ceb760b1df0e747b44ec39df08bf99ecba3b39bc53
MD5 8d6344b1213ccfa47198abe3496b90fc
BLAKE2b-256 996c53dad2d8bee4d6fc060a009d4fa4660ff1300a06c77fc16796c0c433b347

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.7-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for pjdev_armis_sdk-5.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9f7ea8532254224502d9bbce6c7581a2f8fe4aad815d4434ca6fdcfaae615dc0
MD5 ab8e28b2fdbfbbd78513a0df2dea3ff2
BLAKE2b-256 675cd4dcaee880f40b0349e2393a93c87f33ac8562bc6911dda16ae5d1408c36

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