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 newer

  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.33.tar.gz (92.1 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.33-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for alertlogic-sdk-python-1.0.33.tar.gz
Algorithm Hash digest
SHA256 89a599b093bb4c7923fefc16e408b53be9beaa8e1b03f540e7fd3dff8373c7f2
MD5 4df4123e563d3232a734e6be0124cdb2
BLAKE2b-256 0c9c088736604d5fc274d218e5b49274eaa26eb802785fe912666662ecbadcc3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: alertlogic_sdk_python-1.0.33-py3-none-any.whl
  • Upload date:
  • Size: 22.6 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/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

File hashes

Hashes for alertlogic_sdk_python-1.0.33-py3-none-any.whl
Algorithm Hash digest
SHA256 5eebc3ae449617d131caefe829f5ff7e3fa795b58712e15fa86c350caaf96903
MD5 b9c2c210e9d73b46bfaf323b00d0eed7
BLAKE2b-256 f05ebb29e6d1cbea80c3fff0d7df9eda8897d21cebaa3e187c2b5a0994c6e800

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