Alert Logic Software Development Kit for Python.
Project description
# The Alert Logic SDK For Python (almdrlib)
[](https://pypi.python.org/pypi/alertlogic-sdk-python) [](https://pypi.python.org/pypi/alertlogic-sdk-python) [](https://travis-ci.com/alertlogic/alertlogic-sdk-python)
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`
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](https://console.account.alertlogic.com/#/aims/users). For information on creating an access key, see [https://docs.alertlogic.com/prepare/access-key-management.htm](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:
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
File details
Details for the file alertlogic-sdk-python-1.0.23.tar.gz.
File metadata
- Download URL: alertlogic-sdk-python-1.0.23.tar.gz
- Upload date:
- Size: 46.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a6e321f29da25e6c9ad35851cc8d280632c0088261681e3a6856e70b6c9376bd
|
|
| MD5 |
f82f788fe267c8bc441cabb01e801096
|
|
| BLAKE2b-256 |
3ac23783a963b1b65eb6411ff086176301c38c0b314df98ca33048cf48fbad10
|