Skip to main content

Async Python SDK wrapper for Outline Manager VPN

Project description

Async Outline manager sdk

Thanks for the reverse engineering and docs project: https://github.com/jadolg/outline-vpn-api Autor: @jadolg

Example:

from outline_sdk import Service

# Setup the access with the API URL (Use the one provided to you after the server setup)
service = Service(
    url="https://127.0.0.1:51083/xlUG4F5BBft4rSrIvDSWuw/",  # <--- `/` is required 
    cert_sha256="4EFF7BB90BCE5D4A172D338DC91B5B9975E197E39E3FA4FC42353763C4E58765"
)

# Get all access URLs on the server
for key in await service.get_keys():
    print(key)

# Create a new key
new_key = await service.create_key()

# Rename it
await service.rename_key(new_key.id, "new_key")

# Delete it
await service.delete_key(new_key.id)

# Set a monthly data limit for a key (20MB)
await service.set_data_limit(new_key.id, 1000 * 1000 * 20)

# Remove the data limit
await service.delete_data_limit(new_key.id)

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

outline_sdk-0.2.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

outline_sdk-0.2.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file outline_sdk-0.2.0.tar.gz.

File metadata

  • Download URL: outline_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.11.1 Darwin/22.6.0

File hashes

Hashes for outline_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 07a70e67f0ba6218f3dc964008a6f681f55d54947ccf9918efb5489e7d7b07a8
MD5 6b0d834e65ed007a9c3ab61c447fdef8
BLAKE2b-256 7ed76090e9888aaff717f9977887c8bac5767172fac89df2dc6cac7c71acf785

See more details on using hashes here.

File details

Details for the file outline_sdk-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: outline_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.11.1 Darwin/22.6.0

File hashes

Hashes for outline_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b4f46d64fe207b804edcc9395b89aaded6486ab06ff63c1b22e48b0b7fd089f
MD5 7c82d24c5ddaa81035803355da970d46
BLAKE2b-256 2b20cb830828e965d42602a06b188c9851bb64b30fbeb9112d578809cf4aecc4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page