Metadata-Version: 1.1
Name: proxy-toggle
Version: 1.0.3
Summary: A command-line tool to run programs seamlessly behind a proxy.
Home-page: https://github.com/beylsp/proxy-toggle
Author: Patrik Beyls
Author-email: UNKNOWN
License: MIT
Description: ************
        proxy-toggle
        ************
        
        .. image:: https://travis-ci.org/beylsp/proxy-toggle.svg?branch=master
            :target: https://travis-ci.org/beylsp/proxy-toggle
        
        .. image:: https://coveralls.io/repos/github/beylsp/proxy-toggle/badge.svg?branch=master
             :target: https://coveralls.io/github/beylsp/proxy-toggle?branch=master
        
        .. image:: https://readthedocs.org/projects/proxy-toggle/badge
              :target: https://proxy-toggle.readthedocs.io/en/latest/
        
        A command-line tool to run programs seamlessly behind a proxy.
        
        Introduction
        ------------
        
        Many corporate networks use proxies both for network protection and to cache often-used content. This command-line tool allows you to run programs behind a corporate proxy without the need to constantly set/unset proxy environment variables. It sets the environment variables only when needed and unsets them whenever the program finished its execution. Currently, proxy-toggle only supports *Basic Access Authentication* as the authentication scheme to the proxy.
        
        Installation
        ------------
        
        To use proxy-toggle:
        
        .. code-block:: bash
        
            $ pip install proxy-toggle
        
        
        Head over to `pip-installer <http://www.pip-installer.org/en/latest/index.html>`_ for instructions on installing pip.
        
        To run from source, you can `download the source code <https://github.com/beylsp/proxy-toggle>`_ for proxy-toggle, and then run:
        
        .. code-block:: bash
        
            $ python setup.py install
        
        
        Usage
        -----
        
        Before you can start using proxy-toggle, you must initialize the application:
        
        .. code-block:: bash
        
            $ px --init
        
        
        This will prompt for your proxy settings: proxy server URL and user account/password. A secure keyring (to encrypt the password) will be generated. This might take a while.
        
        You can test your proxy settings with following command:
        
        .. code-block:: bash
        
            $ px --test
        
        
        After successful initialization, run:
        
        .. code-block:: bash
        
            $ px <program>
        
        .. role:: bash(code)
           :language: bash
        
        If your proxy doesn't require user authentication, run it with :bash:`--nouser` option:
        
        .. code-block:: bash
        
            $ px --nouser <program>
        
        When you want to renew your proxy password, run it with :bash:`--renew` option:
        
        .. code-block:: bash
        
            $ px --renew
        
        
        Examples
        --------
        
        .. code-block:: bash
        
            $ px git clone https://github.com/beylsp/proxy-toggle
        
            $ px --nouser wget https://github.com/beylsp/archive/master.zip
        
        
        Contributing
        ------------
        
        We love contributions. If you've found a bug in the tool or would like new features added, go ahead and open issues or pull requests against this repo. Write a test to show your bug was fixed or the feature works as expected.
        
        
        1.0.0
        -----
        
        Original open source release
        
        1.0.1
        -----
        
        Unstable release
        
        1.0.2
        -----
        
        First stable release
        
        1.0.3
        -----
        
        Add new positional command-line arguments: '--version', '--test'
        Add full support for python 3.x
        Set 'all_proxy' environment variable as understood by curl
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
