Metadata-Version: 2.1
Name: sysproxy
Version: 0.1.6
Summary: Python bindings for shadowsocks sysproxy utility.
Home-page: https://github.com/LorenEteval/sysproxy
Author: Loren Eteval
Author-email: loren.eteval@proton.me
License: MIT
Description: # sysproxy
        
        [![Deploy PyPI](https://github.com/LorenEteval/sysproxy/actions/workflows/deploy-pypi.yml/badge.svg?branch=main)](https://github.com/LorenEteval/sysproxy/actions/workflows/deploy-pypi.yml)
        
        Python bindings for shadowsocks sysproxy utility. This is a Windows-only package.
        
        ## Install
        
        ```
        pip install sysproxy
        ```
        
        ## API
        
        ```pycon
        >>> import sysproxy
        >>> sysproxy.off() # Turn proxy settings off.
        True
        >>> sysproxy.pac('pac_url') # Turn proxy settings on with PAC.
        True
        >>> sysproxy.set('127.0.0.1:10809', '127.*;10.*;172.16.*') # Turn proxy settings on with server and bypass.
        True
        >>> sysproxy.daemon_off() # Turn proxy daemon off.
        True
        >>> sysproxy.daemon_on_() # Turn proxy daemon on. You should launch this function in a Python thread.
        ```
        
        ## sysproxy daemon
        
        When sysproxy daemon turned on, it executes a window-less WINAPI event loop that captures `WM_QUERYENDSESSION` message,
        which is sent when Windows is about to shutdown. When the message arrives, the daemon calls `off()`, which turns proxy
        settings off.
        
        As mentioned above, `sysproxy.daemon_on_()` will block current Python execution, so you should launch it in a Python
        thread.
        
        ## Tested Platform
        
        sysproxy works on all reasonable Windows platform with all Python version(Python 3).
        
        Below are tested build in [github actions](https://github.com/LorenEteval/sysproxy/actions).
        
        | Platform     | Python 3.6-Python 3.11 |
        |--------------|:----------------------:|
        | windows-2019 |   :heavy_check_mark:   |
        | windows-2022 |   :heavy_check_mark:   |
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: Proxy Servers
Description-Content-Type: text/markdown
