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.4.tar.gz (11.3 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.4-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.4.tar.gz
  • Upload date:
  • Size: 11.3 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.4.tar.gz
Algorithm Hash digest
SHA256 de3d51d36da07e411e43f4fad878d4358b566f4d004f5bf19f60184a850afbce
MD5 6023a9ca0244ee0376ccb5852fed5e82
BLAKE2b-256 276c328e3b509c775ca73abb481de03c65c585f441e5cefffdf7363811332cb5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pjdev_armis_sdk-5.1.4-py3-none-any.whl
  • Upload date:
  • Size: 16.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1fdb905c0c405f6a662b8dc3350ff36061a81363c3b1c763d9429c7e469b678
MD5 25018de8411eb122509f5d692ccf0f74
BLAKE2b-256 3b4a91d6c64665120091ba27a6c0d5623832395f471bc8734b77c2f083252734

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