Skip to main content

Python client for the Outline VPN Management API. Manage access keys, server settings, and metrics programmatically.

Project description

OUTLINE-VPN-API-CLIENT

PyPI - Version PyPI - Format GitHub Release GitHub Actions Workflow Status PyPI - Python Version GitHub License Documentation Status

DESCRIPTION

Python client for the Outline VPN Management API. Manage access keys, configure server settings, and retrieve metrics — both synchronously and asynchronously.

INSTALLATION

pip install outline-vpn-api-client

For async support:

pip install outline-vpn-api-client[async]

QUICK START

from outline_vpn_api_client import OutlineClient

client = OutlineClient(management_url="your.management.url")

# Get server info
print(client.get_information().model_dump())

# Create an access key
key = client.access_keys.create(name="Alice", limit=10**9)
print(key.accessUrl)

For full usage examples and API reference, see the documentation.

HANDLING ERRORS

from outline_vpn_api_client import OutlineClient, ResponseNotOkException

try:
    client.access_keys.get(999)
except ResponseNotOkException as e:
    print(e)

AUTHOR

Created by zeph1rr
Email: grianton535@gmail.com

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_vpn_api_client-1.3.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

outline_vpn_api_client-1.3.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file outline_vpn_api_client-1.3.0.tar.gz.

File metadata

  • Download URL: outline_vpn_api_client-1.3.0.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.12 Linux/6.14.0-1017-azure

File hashes

Hashes for outline_vpn_api_client-1.3.0.tar.gz
Algorithm Hash digest
SHA256 ee4bd8cebbb7b2ce6ec8967d65872da78f110dc14032b5ad18404a37688ce910
MD5 ddbf0c20c944e4f60e81e557d9badb3e
BLAKE2b-256 47adf0714f1eebb07cc65cea72398f2e3d3e892f19400163a231bf4786551d54

See more details on using hashes here.

File details

Details for the file outline_vpn_api_client-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for outline_vpn_api_client-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb8b6c91d47a6109fde38dcc07a073b21930681bb7764403d66325dc0988492
MD5 bab04d2bbacb7e619c5ca196e13b4286
BLAKE2b-256 fa92b5de39333f42a3b3338a1315c0075aabdd987ef7056235e1d891e04fd231

See more details on using hashes here.

Supported by

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