Skip to main content

Object-oriented wrapper around the Linux Tun/Tap device

Project description

https://github.com/johnthagen/pytap2/workflows/python/badge.svg https://codeclimate.com/github/johnthagen/pytap2/badges/gpa.svg https://codeclimate.com/github/johnthagen/pytap2/badges/issue_count.svg https://codecov.io/github/johnthagen/pytap2/coverage.svg https://img.shields.io/pypi/v/pytap2.svg https://img.shields.io/pypi/status/pytap2.svg https://img.shields.io/pypi/pyversions/pytap2.svg

Fork of PyTap that supports Python 3.

Requirements

The ifconfig command line utility must be installed for pytap2 to operate.

To install ifconfig on Debian/Ubuntu:

$ sudo apt install net-tools

To install ifconfig on RHEL/Rocky Linux/Fedora:

$ sudo yum install net-tools

Installation

You can install, upgrade, and uninstall pytap2 with these commands:

$ pip install pytap2
$ pip install --upgrade pytap2
$ pip uninstall pytap2

Usage

Using as a context manager automatically brings up the device and closes it at the end of the with block.

from pytap2 import TapDevice

with TapDevice() as device:
    device.ifconfig(mtu=1300)
    device.write(b'0000')

Or manually call up() and close().

from pytap2 import TapDevice

device = TapDevice()
device.up()
device.ifconfig(mtu=1300)
device.write(b'0000')
device.close()

The fileno() method is defined, so that the device object can be passed directly to select().

Releases

2.3.0 - 2023-04-28

  • Drop Python 3.7 and support Python 3.11

  • Support Mypy type checking for users

2.2.0 - 2021-11-06

  • Drop Python 3.6 and support Python 3.10.

  • Document dependency on ifconfig

2.1.0 - 2020-12-30

  • Drop Python 3.5 and support Python 3.9.

  • Switch to GitHub Actions for CI.

2.0.0 - 2020-03-29

  • Drop Python 2.7.

1.6.0 - 2019-12-15

  • Drop Python 3.4 and support Python 3.8.

  • Include license file.

1.5.0 - 2018-07-09

Support Python 3.7.

1.4.0 - 2017-10-24

Allow disabling packet information header (IFF_NO_PI) and default read() to read entire MTU worth of data plus the packet information header if present.

1.3.0 - 2017-07-31

Add fileno() method to support select() calls.

1.2.0 - 2017-06-19

Context manager support added.

1.1.0 - 2017-06-17

Allow read() to be called with a specific number of bytes to read.

1.0.0 - 2017-06-16

Initial release that supports Python 2 and 3.

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

pytap2-2.3.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

pytap2-2.3.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file pytap2-2.3.0.tar.gz.

File metadata

  • Download URL: pytap2-2.3.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for pytap2-2.3.0.tar.gz
Algorithm Hash digest
SHA256 5a90d7b7c7107a438e53c7b27c1baadffe72889ada6024c02d19801fece2c383
MD5 57d7be09c42967adbdf9269fefa2743e
BLAKE2b-256 7d4ab554c4bd7c38a3a407ecb50627088e1147ff11ca02f66af36b8c3fbc6c91

See more details on using hashes here.

Provenance

File details

Details for the file pytap2-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: pytap2-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for pytap2-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1edc287cf25c61f8fa8415fb6b61e50ac119ef5cd758ce15f2105d2c69f24ef
MD5 f586b13c516ff85a1e250f3e26dc46ff
BLAKE2b-256 d21214dc51cc7191ec3e80cedb4bdc92509145b4fe1f4d4ec1892cb12c268ade

See more details on using hashes here.

Provenance

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