Skip to main content

PyOutline: CLI app to start Outline VPN keys

With PyOutline you can easily run ShadowSocks proxy from the Outline keys.

Installation

PIP (PyPI)

pip install pyoutline

With clone from GitHub

git clone https://github.com/NonProjects/pyoutline
pip install ./pyoutline

Optional requirements

You can install latest Shadowsocks if you're on Linux:

apt install shadowsocks-libev # e.g Debian

Usage

The "How to use" is pretty simple:

pyoutline client -k "ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118"

If you want to transform Outline Key into the ss-local string:

pyoutline to-ss -k "ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118"
# ^ ss-local -s "ak1344.free.www.outline.network" -p 8118 -k "cdBIDV42DCwnfIN" -m "aes-256-gcm" -l 53735

Set your own port or ask system to set the free one

pyoutline client -p 50000 # Set port 50000, script will ask you for Key
pyoutline client -r # Get a random port, script will ask you for Key

You can also specify keys from the file. First working Key will be used:

pyoutline client -k /home/user/outline_keys.txt

The insides of the file with keys should be placed like this:

ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118
ss://YWVzLTI1Ni1nY206VEV6amZBWXEySWp0dW9T@ak1343.free.www.outline.network:6679
ss://Y2hhY2hhMjAtaWV0Zi1wb2x5MTMwNTpHIXlCd1BXSDNWYW8=@ak1338.free.www.outline.network:810

Metadata

Release files for pyoutline 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyoutline 0.4
File Size Uploaded Provenance Actions
pyoutline-0.4.tar.gz 5.1 kB Without provenance Details for pyoutline-0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyoutline 0.4
File Interpreter ABI Platform Actions
pyoutline-0.4-py3-none-any.whl Python 3 none any Details for pyoutline-0.4-py3-none-any.whl

Total release size: 10.8 kB

Release files / pyoutline-0.4.tar.gz

Download URL pyoutline-0.4.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4ce9bceec7907be200856e7f141e568310e7b2803b41a24841d663f17e756ada
BLAKE2b-256 checksum
How to use checksums
7d5ce93ccd8d33d60aa23c9ef0b18dee1061c4e8da69f1afdc73cfdebe4610c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.2

Release files / pyoutline-0.4-py3-none-any.whl

Download URL pyoutline-0.4-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f1ba2b27f911b467d7be0c81871438b613e6b562d8752c43a64787d6c2d8e0f
BLAKE2b-256 checksum
How to use checksums
020eea224d53cca976464bcfd7536818a94dd170a0a3fec02124902356671cb1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.2

Security for pyoutline 0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page