Skip to main content

Armorblox SDK for Python

Project description

Armorblox logo

Armorblox Python SDK (Alpha)

Apache-2 License

This is an alpha version of the SDK with limited documentation and no support.

Requirements

Python 3.5+

Installation

pip install armorblox-sdk

Usage

from armorblox import client

# Create an API client for your tenant
c = client.Client(api_key='your-api-key-here', instance_name='yourtenantname')

# Fetch a list of threats
threat_incidents = c.threats.list()

# Fetch a specific threat
incident = c.threats.get(44006)


# Fetch a list of abuse incidents
abuse_incidents = c.abuse_incidents.list()

# Fetch a specific abuse incident
abuse_incident = c.abuse_incidents.get(44200)


# Fetch a list of DLP incidents
dlp_incidents = c.dlp_incidents.list()

# Fetch a specific DLP incident
dlp_incident = c.dlp_incidents.get(44010)

Contributing

  • Install Poetry
  • Clone the SDK repo & cd into it
git clone https://github.com/armorblox/armorblox-python-sdk
cd armorblox-python-sdk
  • Run poetry install to install the dependencies
  • Run tox to run the tests

Publishing

TestPyPI

poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi <your-TestPyPI-token>
poetry publish --build -r test-pypi

Use

pip install --index-url https://test.pypi.org/simple/ --no-deps armorblox

to make sure the installation works correctly.

PyPI

poetry config pypi-token.pypi <your-PyPI-token>
poetry publish --build

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

armorblox-sdk-0.1.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

armorblox_sdk-0.1.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file armorblox-sdk-0.1.0.tar.gz.

File metadata

  • Download URL: armorblox-sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.9.5 Darwin/21.5.0

File hashes

Hashes for armorblox-sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 86a9746d562ad10d3fba57ab2ee7a1058aa6458e4cce19216a696ad56de605f2
MD5 0511268acd4c2be1a3164e7a05e6303a
BLAKE2b-256 c98459e17fcd32184132bbc3d07d1c6b437eca8cdb8c6c9ef77f51b015fb033e

See more details on using hashes here.

File details

Details for the file armorblox_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: armorblox_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.9.5 Darwin/21.5.0

File hashes

Hashes for armorblox_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be3bab5051b48746e30a14df4909f7bc388251d8ab9129f39f879a737ed9ab87
MD5 c2ac6cb0a6e7fe5eb52e54b4ad91229c
BLAKE2b-256 8a176e634ac86045e5110311521a058858ca1307bea1fa4977c6245fcd4fe79e

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