Skip to main content

Alert Logic Software Development Kit for Python.

Project description

The Alert Logic SDK For Python (almdrlib)

pypi python Build Status

Alert Logic Software Development Kit for Python allows developers to integrate with Alert Logic MDR Services.

Quick Start

  1. Install the library:

    pip install alertlogic-sdk-python

  2. Set up configuration file (in e.g. ~/.alertlogic/config

    [default]
    access_key_id = YOUR_KEY
    secret_key = YOUR_SECRET
    

    To create and manage access keys, use the Alert Logic Console. For information on creating an access key, see https://docs.alertlogic.com/prepare/access-key-management.htm

    Optionally you can specify if you are working with integration deployment of Alert Logic MDR Services or production by specifying:

    global_endpoint=integration
    
    global_endpoint=production
    

    NOTE: If global_endpoint isn't present, SDK defaults to production.

  3. Test installation Launch python interpreter and then type:

    import almdrlib
    aims = almdrlib.client("aims")
    res = aims.get_account_details()
    print(f"{res.json()}")
    

Development

Getting Started

Prerequisites:

  1. Python v3.7 or older

  2. virtualenv or virtualenvwrapper (We recommend virtualenvwrapper https://virtualenvwrapper.readthedocs.io/en/latest/ )

  3. To produce RESTful APIs documentation install redoc-cli and npx:

    npm install --save redoc-cli
    npm install --save npx
    

Setup your development environment and install required dependencies:

export WORKON_HOME=~/environments
mkdir -p $WORKON_HOME
source /usr/local/bin/virtualenvwrapper.sh
mkvirtualenv alsdk
git clone https://github.com/alertlogic/alertlogic-sdk-python
cd alertlogic-sdk-python
pip install -r requirements_dev.txt
pip install -e .

======= History

1.0.1 (2020-02-06)

  • First release on PyPI.

1.0.4 (2020-02-07)

  • Introduce Search API support (beta)

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

alertlogic-sdk-python-1.0.31.tar.gz (91.2 kB view details)

Uploaded Source

Built Distribution

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

alertlogic_sdk_python-1.0.31-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file alertlogic-sdk-python-1.0.31.tar.gz.

File metadata

  • Download URL: alertlogic-sdk-python-1.0.31.tar.gz
  • Upload date:
  • Size: 91.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/48.0.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

File hashes

Hashes for alertlogic-sdk-python-1.0.31.tar.gz
Algorithm Hash digest
SHA256 505714cf3244733fc2a4f2baa00a8225cb769ddc66f459f0797914010388c525
MD5 e7a28ed4e310c833b7a6b988148be6d8
BLAKE2b-256 bf0098fa9ff5fbddabd0d80191c318172888102a5f6361567cbf669ef9706f57

See more details on using hashes here.

File details

Details for the file alertlogic_sdk_python-1.0.31-py3-none-any.whl.

File metadata

  • Download URL: alertlogic_sdk_python-1.0.31-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/48.0.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

File hashes

Hashes for alertlogic_sdk_python-1.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 5d66cec6832045918beb4c43aa819aeadca5ae3988267c5a1a9efa23eb9183d1
MD5 67bbd0edf746ef4282c782704da67bb7
BLAKE2b-256 40751d9cd0827028391510ee68a65d54095e84cabf999b37437d74fe61a0cc15

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