Skip to main content

Cross platform python library to set system-wide proxy and bypass domains for proxy.

Project description

banner

GitHub License wakatime PyPI - Version PyPI - Python Version

Uniproxy

Cross-platform python library to set system-wide proxy and proxy bypass domains.

[!IMPORTANT] Uniproxy doesn't provide a proxy server. It only sets the system-wide proxy settings.

Features

  • Cross Platform: Uniproxy is cross-platform and can be used on Windows, macOS and Linux.
  • System Wide Proxy: Uniproxy can be used to set system-wide proxy for the host.
  • Bypassing Domains: Uniproxy can be used to set bypass domains which don't go through the system-wide proxy.
  • Environment Variables: Uniproxy can also set environment variables for the proxy.

Installation

$ pip3 install uniproxy

Getting Started

Install the package as mentioned above and import it.

Proxy setup

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.set_proxy()  ## Set system-wide proxy without changing the current proxy enabled state for the OS
prox.set_proxy_enabled(True)  ## Enable system-wide proxy

This will first edit the OS Settings to set the proxy and then enable the proxy.

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.join()  ## Change

As an alternative, you can also use the above method to set the proxy and enable it directly.

Bypass Domains

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.set_bypass_domains(["www.google.com", "www.facebook.com"])  ## Set bypass domains

This will set the bypass domains for the proxy. The domains mentioned in the list will not pass through the proxy. Environment variables no_proxy and NO_PROXY will also be set.

Turn off Proxy

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.set_proxy_enabled(False)  ## Disable system-wide proxy

This will disable the system-wide proxy.

Delete Proxy

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.delete_proxy()  ## Delete the proxy settings

This will delete the proxy settings from the system and set them to OS defaults.

Get Proxy Details

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.join()
print(prox.get_proxy())  ## Get the proxy details

This will output the following (on Linux, KDE)

{
    "is_enable": True,
    "http": {"ip_address": "127.0.0.1", "port": "8081"},
    "https": {"ip_address": "127.0.0.1", "port": "8081"},
    "ftp": {"ip_address": "127.0.0.1", "port": "8081"},
}

Get Bypass Domains

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
prox.set_bypass_domains(["www.google.com", "www.facebook.com"])  ## Set bypass domains
print(prox.get_bypass_domains())  ## Get bypass domains

This will output the following

['www.google.com', 'www.facebook.com']

MacOS Specific Functionality

Get default network service

import uniproxy

prox = uniproxy.Uniproxy(ip="127.0.0.1", port=8081)  ## Create a uniproxy instance
print(prox.proxy.get_default_network_service())  ## Get the default network service

This will output the following (depends on the system and current network configuration):

Wi-Fi

Default network service is determined by parsing the output of route -n get default command. If it fails for some reason the default network service is found out by parsing the output of networksetup -listallnetworkservices command and returning the first network service which is not disabled.

Known Issues

  • Uniproxy only works on SystemD based Linux systems.
  • Uniproxy only supports KDE and GNOME desktop environments on Linux.

Credits

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

uniproxy-0.1.4.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

uniproxy-0.1.4-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file uniproxy-0.1.4.tar.gz.

File metadata

  • Download URL: uniproxy-0.1.4.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.11.5-zen1-1-zen

File hashes

Hashes for uniproxy-0.1.4.tar.gz
Algorithm Hash digest
SHA256 0a46aee3dfb7e98d6f1a809e01a5f957155715e451856c0bf707b5e85fc8eb0d
MD5 2c0351caf1f0d2ff07822db3f479c849
BLAKE2b-256 fb2af4f138109bbe365588b6773e77e58da9e5608eca1bea8fbd6e6bdecda8f1

See more details on using hashes here.

File details

Details for the file uniproxy-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: uniproxy-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.11.5-zen1-1-zen

File hashes

Hashes for uniproxy-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c390519a287b0bdd4f8580ce8f6ee0075370d1b0d17431b9af995b31777b3e1a
MD5 9c973144dd1886656ab14459c34502ef
BLAKE2b-256 e93828c5d85e272d7da7b45b203bbd0a1f3086b3925a2dfc98f763520a6a783b

See more details on using hashes here.

Supported by

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