Metadata-Version: 2.1
Name: outline-vpn-api
Version: 1.1.0
Summary: Python API wrapper for Outline VPN
Home-page: https://github.com/jadolg/outline-vpn-api/
Author: Jorge Alberto Díaz Orozco (Akiel)
Author-email: diazorozcoj@gmail.com
License: MIT
Description: # outline-vpn-api
        
        A Python API wrapper for [Outline VPN](https://getoutline.org/)
        
        [![Test](https://github.com/jadolg/outline-vpn-api/actions/workflows/test.yml/badge.svg)](https://github.com/jadolg/outline-vpn-api/actions/workflows/test.yml)
        
        ## How to use
        
        ```python
        from outline_vpn.outline_vpn import OutlineVPN
        
        # Setup the access with the API URL (Use the one provided to you after the server setup)
        client = OutlineVPN(api_url="https://127.0.0.1:51083/xlUG4F5BBft4rSrIvDSWuw")
        
        # Get all access URLs on the server
        for key in client.get_keys():
            print(key.access_url)
        
        # Create a new key
        new_key = client.create_key()
        
        # Rename it
        client.rename_key(new_key.key_id, "new_key")
        
        # Delete it
        client.delete_key(new_key.key_id)
        
        # Set a monthly data limit for a key (20MB)
        client.add_data_limit(new_key.key_id, 1024 * 1024 * 20)
        
        # Remove the data limit
        client.delete_data_limit(new_key.key_id)
        
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
