All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.2.0 - 2024-01-10
- New asynchronous client
AsyncOutlineClient
usingaiohttp
- Comprehensive type hints and overloads for better IDE support
- New methods for server management:
rename_server()
- Change server nameset_hostname()
- Configure server hostnameget_metrics_status()
- Check metrics collection statusset_metrics_status()
- Enable/disable metrics collection
- Support for different metrics periods (DAILY, WEEKLY, MONTHLY)
- Extended options for access key creation (method, encryption settings)
- Improved error handling with detailed error messages
- Context manager support with async
__aenter__
and__aexit__
- Complete rewrite of the client to support asynchronous operations
- Enhanced error hierarchy with
OutlineError
base class - Improved request handling with automatic session management
- More flexible SSL/TLS certificate verification
- Better JSON response parsing and validation
- Updated type annotations to use modern Python typing features
- Synchronous client implementation (migrated to async)
- Direct requests-based HTTP handling
0.1.2 - 2024-01-09
- Initial release with synchronous client
- Basic Outline VPN server management features:
- Server information retrieval
- Access key management (create, list, delete)
- Data limit management
- Server port configuration
- Basic metrics retrieval
- Pydantic models for data validation
- Support for custom certificate verification
- Optional JSON response format