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.28.tar.gz (91.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.28-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alertlogic-sdk-python-1.0.28.tar.gz
  • Upload date:
  • Size: 91.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.0

File hashes

Hashes for alertlogic-sdk-python-1.0.28.tar.gz
Algorithm Hash digest
SHA256 74eb3a3d46de6c9a55afc8cf2038caad375e3278af137665736b321904e93ad9
MD5 a0a7fe50111964131eaa758997d164b6
BLAKE2b-256 031a146ad222f1c04780c9fe63767d5d29eef8aee74bb26d6008e358275ec826

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for alertlogic_sdk_python-1.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 3133f70635e5c673e54b18d7124a537d15bc19510d0ba320c23c41b55958959e
MD5 8dc15d850acff882c492d2e61542eaf9
BLAKE2b-256 c16da21ba776b3307b19ce639f9127bbbb7209dc533dbe1757b6180bb2633080

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