Metadata-Version: 2.1
Name: outline-api
Version: 0.0.5
Summary: A wrapper library to facilitate the access to Outline VPN as well as its Prometheus APIs on Outline VPN Servers.
Home-page: https://github.com/ASL-19/outline-api
Author: ASL19 Software Development Team
Author-email: dev@asl19.org
License: GPLv3
Keywords: Outline,Outline Manager,Outline VPN,Outline API
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Outline API

[![PyPI version](https://badge.fury.io/py/outline-api.svg)](https://badge.fury.io/py/outline-api)

Outline API is a wrapper api written in python to access Outline VPN API services. Outline VPN APIs are used for Outline keys maintenance as well as for monitoring purposes. The package also provides wrappers to access Prometheus on the Outline VPN.

## Install

use pip to install the package:
```
pip install outline-api
```


## Using package

import the package and cerate a management object.

```python
from outline_api import (
    Manager,
    get_key_numbers, 
    get_active_keys)


apiurl = "http://127.0.0.1/apikey"
apicrt = "apicert"
manager = Manager(apiurl=apiurl, apicrt=apicrt)

new_key = manager.new()
if new_key is not None:
    print(new_key)

keys = get_key_numbers("127.0.0.1", "999")
print(keys)

active_keys = get_active_keys("127.0.0.1", "999")
print(active_keys)
```


CHANGELOG
=========

0.0.5 (2021-10-29)
------------------

- Add custom error exceptions


0.0.4 (2021-10-27)
------------------

- Fix timeout values


0.0.3 (2021-07-30)
------------------

- Fix return values in case of error


0.0.1 (2020-08-01)
------------------

- First version

