Metadata-Version: 1.0
Name: pytun
Version: 1.0
Summary: Python TUN/TAP tunnel module
Home-page: https://github.com/Gawen/pytun
Author: Gawen Arab
Author-email: g@wenarab.com
License: MIT
Description: # pytun
        
        `pytun` is a Python module to manage tun/tap IP tunnel in the same way you would manipulate a file handler.
        
        For now, it is only compatible with Linux, probably Unix, maybe MacOsX, and in the future Windows.
        
        `pytun` is under the MIT license.
        
        ## How to use
        
        Quite easy. Use the `open()` function.
        
            import pytun
        
            tun = pytun.open()  # Open a TUN mode tunnel
        
        For a TAP tunnel, add the `"tap"` argument.
        
            tun = pytun.open("tap")
        
        `tun` is the handler for the newly created tunnel and is manipulated like a file.
        
        To read/write, use the standard methods `recv([size = 1500])` and `send(buf)`
        
            buf = tun.recv()
            tun.send(buf)
        
        tun is also `select()` compatible to make your network reactor asynchronous.
        
            import select
        
            fds = select.select([tun, ...], [...], [...])
        
        Finally, you can close the tunnel using the method `close()`.
        
            tun.close()
        
        The tunnel automatically closes when the object is not referenced anymore and the garbage collector destroys the handler.
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: System :: Networking
Classifier: Topic :: Software Development :: Libraries :: Python Modules
