Skip to main content

Armorblox SDK for Python

Project description

Armorblox logo

Armorblox Python SDK (Alpha)

PyPI version 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-sdk

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: armorblox-sdk-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 5216282dfc1d683b90f4c0c086fba9bde6cd14ceedd2ea0211c4410750b975d6
MD5 266e5e1de9a946d59683bb2c3b17d5ff
BLAKE2b-256 579acd69108128675a46d5fc4713915f7e9fd11df52a5adacc45c0dc74b2e63e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: armorblox_sdk-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d6ff6a47b74e32c0caf9bf31b09381cfd9d93dce65f0791e0bee318b15f200e1
MD5 f82e4cf6f7b50ed633da576ae56b49b5
BLAKE2b-256 41e493d6c135eb66d7e44b4d06c30629b038b4c66f2edb1d5392cc4a9685ed6c

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