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
    

    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
(alsdk) $ git clone https://github.com/alertlogic/alertlogic-sdk-python
(alsdk) $ cd alertlogic-sdk-python
(alsdk) $ pip install -r requirements_dev.txt
(alsdk) $ 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.13.tar.gz (42.3 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: alertlogic-sdk-python-1.0.13.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.7

File hashes

Hashes for alertlogic-sdk-python-1.0.13.tar.gz
Algorithm Hash digest
SHA256 4335b27f11927e91e2f8634d5260ae13f60f073d1c00d3b6190572cbc9469401
MD5 57aa2871f990c6230b7a806591e4ec1b
BLAKE2b-256 b6bd369a5936086267713e88a808f134af5f813336429b23d4bc6e390772e397

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