Alert Logic Software Development Kit for Python.
Project description
The Alert Logic SDK For Python (almdrlib)
Alert Logic Software Development Kit for Python allows developers to integrate with Alert Logic MDR Services.
Quick Start
-
Install the library:
pip install alertlogic-sdk-python
-
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.
-
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:
-
Python v3.7 or older
-
virtualenv or virtualenvwrapper (We recommend virtualenvwrapper https://virtualenvwrapper.readthedocs.io/en/latest/ )
-
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for alertlogic-sdk-python-1.0.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0517270b3fd8d925110ca595b8414e86139fe14396e92c7cb709b5f6dc2f791b |
|
MD5 | d44bc69388a7caf35e304d73e86c5f5a |
|
BLAKE2b-256 | 62aaf2644449aebcc510711bb13523415d0f24c0527b2395fe2ffcde16d13f2c |