Metadata-Version: 2.1
Name: alertlogic-sdk-python
Version: 1.0.35
Summary: Alert Logic Software Development Kit for Python.
Home-page: https://github.com/alertlogic/alertlogic-sdk-python
Author: Alert Logic Inc.
Author-email: devsupport@alertlogic.com
License: MIT license
Keywords: alertlogic-sdk,alertlogic-sdk-python,alertlogic-mdr-sdk,almdrlib,alertlogic
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.18)
Requires-Dist: configparser (>=4.0.2)
Requires-Dist: pyyaml (==5.1.2)
Requires-Dist: jsonschema[format_nongpl] (==3.2.0)
Requires-Dist: m2r (==0.2.1)
Requires-Dist: alertlogic-sdk-definitions (>=0.0.23)
Provides-Extra: dev
Requires-Dist: pytest (>=3) ; extra == 'dev'
Requires-Dist: mock (>=2.0.0) ; extra == 'dev'
Requires-Dist: httpretty (>=0.8.14) ; extra == 'dev'
Requires-Dist: pycodestyle (>=2.3.1) ; extra == 'dev'
Requires-Dist: jsonschema[format_nongpl] (==3.2.0) ; extra == 'dev'

# The Alert Logic SDK For Python (almdrlib)

[![pypi](https://img.shields.io/pypi/v/alertlogic-sdk-python.svg)](https://pypi.python.org/pypi/alertlogic-sdk-python)
[![python](https://img.shields.io/pypi/pyversions/alertlogic-sdk-python.svg)](https://pypi.python.org/pypi/alertlogic-sdk-python)
[![Build Status](https://travis-ci.com/alertlogic/alertlogic-sdk-python.svg?branch=master)](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```

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](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:

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)


