{"id":24411151,"url":"https://github.com/orenlab/pyoutlineapi","last_synced_at":"2026-03-02T12:01:14.123Z","repository":{"id":255159617,"uuid":"848723312","full_name":"orenlab/pyoutlineapi","owner":"orenlab","description":"A modern, async-first Python client for the Outline VPN Server API with comprehensive data validation through Pydantic models.","archived":false,"fork":false,"pushed_at":"2026-02-13T11:04:26.000Z","size":2487,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-13T19:27:11.861Z","etag":null,"topics":["aiohttp","api","asincio","manager","outline","python","shadowsocks","vpn","wrapper"],"latest_commit_sha":null,"homepage":"https://orenlab.github.io/pyoutlineapi/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orenlab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-28T09:36:34.000Z","updated_at":"2026-02-13T10:52:49.000Z","dependencies_parsed_at":"2025-01-10T10:31:07.136Z","dependency_job_id":"e240a4d7-b7e3-489d-bd02-54110726f9a4","html_url":"https://github.com/orenlab/pyoutlineapi","commit_stats":null,"previous_names":["orenlab/pyoutlineapi"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/orenlab/pyoutlineapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orenlab%2Fpyoutlineapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orenlab%2Fpyoutlineapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orenlab%2Fpyoutlineapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orenlab%2Fpyoutlineapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orenlab","download_url":"https://codeload.github.com/orenlab/pyoutlineapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orenlab%2Fpyoutlineapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30001652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T11:09:27.951Z","status":"ssl_error","status_checked_at":"2026-03-02T11:08:53.255Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiohttp","api","asincio","manager","outline","python","shadowsocks","vpn","wrapper"],"created_at":"2025-01-20T06:19:51.038Z","updated_at":"2026-03-02T12:01:14.095Z","avatar_url":"https://github.com/orenlab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyOutlineAPI\n\n**Enterprise-grade async Python client for Outline VPN Server Management API**\n\n[![tests](https://github.com/orenlab/pyoutlineapi/actions/workflows/python_tests.yml/badge.svg)](https://github.com/orenlab/pyoutlineapi/actions/workflows/python_tests.yml)\n[![codecov](https://codecov.io/gh/orenlab/pyoutlineapi/branch/main/graph/badge.svg?token=D0MPKCKFJQ)](https://codecov.io/gh/orenlab/pyoutlineapi)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=orenlab_pyoutlineapi\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=orenlab_pyoutlineapi)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=orenlab_pyoutlineapi\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=orenlab_pyoutlineapi)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=orenlab_pyoutlineapi\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=orenlab_pyoutlineapi)\n\n![PyPI - Downloads](https://img.shields.io/pypi/dm/pyoutlineapi)\n![PyPI - Version](https://img.shields.io/pypi/v/pyoutlineapi)\n![Python Version](https://img.shields.io/pypi/pyversions/pyoutlineapi)\n![License](https://img.shields.io/pypi/l/pyoutlineapi)\n\n---\n\n## Overview\n\nPyOutlineAPI is a modern, **production-ready** Python library for managing [Outline VPN](https://getoutline.org/)\nservers.\nIt is async-first, type-safe, and designed for reliable operation in production.\n\nHighlights:\n\n- Async-first client built on aiohttp\n- Certificate pinning + sensitive data protection\n- Circuit breaker, health monitoring, retries with backoff\n- Typed models (Pydantic v2) + rich validation\n- Batch operations and rate limiting\n\n---\n\n## Installation\n\n**Requirements:** Python 3.10+\n\nUsing `pip`:\n\n```bash\npip install pyoutlineapi\n```\n\nUsing `uv` (recommended):\n\n```bash\nuv add pyoutlineapi\n```\n\n**Optional dependencies:**\n\n```bash\n# Development tools\npip install pyoutlineapi[dev]\n```\n\n---\n\n## Quick Start\n\n### 1) Setup configuration\n\n```bash\n# Generate .env template\npython -c \"from pyoutlineapi import quick_setup; quick_setup()\"\n\n# Edit .env.example → .env\nOUTLINE_API_URL=https://your-server.com:12345/your-secret-path\nOUTLINE_CERT_SHA256=your-64-character-sha256-fingerprint\n```\n\n### 2) Minimal usage\n\n```python\nfrom pyoutlineapi import AsyncOutlineClient\nimport asyncio\n\n\nasync def main():\n    async with AsyncOutlineClient.from_env() as client:\n        server = await client.get_server_info()\n        print(f\"Server: {server.name} (v{server.version})\")\n\n        key = await client.create_access_key(name=\"Alice\")\n        print(f\"Access URL: {key.access_url}\")\n\n        keys = await client.get_access_keys()\n        print(f\"Total keys: {keys.count}\")\n\n\nasyncio.run(main())\n```\n\n---\n\n## Documentation\n\nDetailed examples and guides are in `docs/guides/`. Start with the index:\n\n- [Guides index](docs/guides/README.md) (full list)\n- [Access keys](docs/guides/access-keys.md)\n- [Server management](docs/guides/server-management.md)\n- [Metrics](docs/guides/metrics.md)\n- [Enterprise features](docs/guides/enterprise-features.md)\n- [Configuration](docs/guides/configuration.md)\n- [Error handling](docs/guides/error-handling.md)\n- [Best practices](docs/guides/best-practices.md)\n\n---\n\n## License\n\nMIT. See `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forenlab%2Fpyoutlineapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forenlab%2Fpyoutlineapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forenlab%2Fpyoutlineapi/lists"}