Skip to content

Commit

Permalink
Rename README in README.rst and complete it.
Browse files Browse the repository at this point in the history
  • Loading branch information
montag451 committed Mar 6, 2012
1 parent f8cdb38 commit d70c8d5
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 62 deletions.
62 changes: 0 additions & 62 deletions README

This file was deleted.

60 changes: 60 additions & 0 deletions README.rst
@@ -0,0 +1,60 @@
Linux TUN/TAP wrapper for Python
================================

``pytun`` is a Python module which let you create TUN/TAP device very easily.

License: MIT (see LICENSE)

Installation and Dependencies
-----------------------------

To install ``pytun``, `download the zip archive
<https://github.com/montag451/pytun/zipball/master>`_, decompress it and
execute ``python setup.py install``. As ``pytun`` is a C module you will need a
compiler (e.g GCC) and the Python developpement headers installed on your
system (e.g on Debian-like distribution check that ``build-essential`` and
``python-dev`` are present). There are no dependencies other than the Python
Standard Library.

Examples
--------

NOTE: On most distributions you will need to be root to run this examples.

To create a TUN device::

from pytun import TunTapDevice

tun = TunTapDevice()

To create a TAP device::

from pytun import TunTapDevice, IFF_TAP

tap = TunTapDevice(flags=IFF_TAP)

To create a TUN/TAP device with a custom name use the ``name`` keyword::

tun = TunTapDevice(name='mytun')

You can get/set some parameters of the device directly::

print tun.name
tun.addr = '10.8.0.1
tun.dstaddr = '10.8.0.2
tun.netmask = '255.255.255.0'
tun.mtu = 1500

To read/write to the device, use the methods ``read(size)`` and
``write(buf)``::

buf = tun.read(tun.mtu)
tun.send(buf)

When when you are done with a device, close it::

tun.close()

You can also use ``TunTapDevice`` objects with all functions that expect a
``fileno()`` method (e.g ``select()``)

0 comments on commit d70c8d5

Please sign in to comment.