Metadata-Version: 2.4
Name: pcap-ct
Version: 1.2.3b1
Summary: Python wrapper for the pcap library (ctypes/cffi-based pypcap).
Home-page: https://pypi.org/project/pcap-ct/
Download-URL: https://pypi.org/project/pcap-ct/
Author: Adam Karpierz
Author-email: adam@karpierz.net
Maintainer: Adam Karpierz
Maintainer-email: adam@karpierz.net
License: BSD license ; https://opensource.org/licenses/BSD-3-Clause/
Keywords: pcap-ct,pypcap,pcap,libpcap,wpcap,npcap
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: Polish
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Stackless
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5.0
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE
Requires-Dist: setuptools>=41.2.0
Requires-Dist: libpcap
Provides-Extra: doc
Requires-Dist: Sphinx>=2.2.1; extra == "doc"
Requires-Dist: restructuredtext-lint>=1.3.0; extra == "doc"
Provides-Extra: test
Requires-Dist: dpkt>=1.9.2; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: summary

pcap-ct
=======

Python wrapper for the *pcap* library.

Overview
========

| Python |package_bold| package is a simplified object-oriented Python wrapper
  for *libpcap* C library - the current tcpdump.org version, and the WinPcap
  port for Windows..
|
| |package_bold| is a pure Python package, based on the low-level
  `libcap <https://pypi.org/project/libpcap/>`__ package.
| It is fully compliant implementation of the original
  `PyPCAP <https://github.com/pynetwork/pypcap>`__ 1.2.3 API (with some minor
  improvements and bug fixes) by implementing whole its functionality in a
  clean Python instead of Cython and C.

About original PyPCAP:
----------------------

Borrowed from the `original website <https://pypcap.readthedocs.io>`__:

PyPCAP
------

This is a simplified object-oriented Python wrapper for libpcap -
the current tcpdump.org version, and the WinPcap port for Windows.

Example use::

    >>> import pcap
    >>> sniffer = pcap.pcap(name=None, promisc=True, immediate=True, timeout_ms=50)
    >>> addr = lambda pkt, offset: '.'.join(str(ord(pkt[i])) for i in range(offset, offset + 4))
    >>> for ts, pkt in sniffer:
    ...     print('%d\tSRC %-16s\tDST %-16s' % (ts, addr(pkt, sniffer.dloff + 12), addr(pkt, sniffer.dloff + 16)))
    ...

Windows notes
-------------

WinPcap has compatibility issues with Windows 10, therefore
it's recommended to use `Npcap <https://nmap.org/npcap/>`_
(Nmap's packet sniffing library for Windows, based on the WinPcap/Libpcap libraries,
but with improved speed, portability, security, and efficiency).
Please enable WinPcap API-compatible mode during the library installation.

Requirements
============

- | It is a fully independent package.
  | All necessary things are installed during the normal installation process.
- ATTENTION: currently works and tested only for Windows.

Installation
============

Prerequisites:

+ Python 3.5 or higher

  * https://www.python.org/
  * 3.7 with C LIBPCAP 1.8.1 is a primary test environment.

+ pip and setuptools

  * https://pypi.org/project/pip/
  * https://pypi.org/project/setuptools/

To install run:

.. parsed-literal::

    python -m pip install --upgrade |package|

Development
===========

Visit `development page`_.

Installation from sources:

clone the sources:

.. parsed-literal::

    git clone |respository| |package|

and run:

.. parsed-literal::

    python -m pip install ./|package|

or on development mode:

.. parsed-literal::

    python -m pip install --editable ./|package|

Prerequisites:

+ Development is strictly based on *tox*. To install it run::

    python -m pip install --upgrade tox

License
=======

  | Copyright (c) 2016-2019, Adam Karpierz
  |
  | Licensed under the BSD license
  | https://opensource.org/licenses/BSD-3-Clause/
  | Please refer to the accompanying LICENSE file.

Authors
=======

* Adam Karpierz <adam@karpierz.net>

.. |package| replace:: pcap-ct
.. |package_bold| replace:: **pcap-ct**
.. |respository| replace:: https://github.com/karpierz/pcap-ct.git
.. _development page: https://github.com/karpierz/pcap-ct/

Changelog
=========

1.2.3b1 (2019-11-14)
--------------------
- Update for PyPCAP 1.2.3.
- Drop support for Python 2.
- Drop support for Python 3.4.
- Add support for Python 3.8.
- Setup improvements and cleanup.

1.2.0b6 (2019-02-05)
--------------------
- Update required setuptools version.
- Minor setup improvements.

1.2.0b5 (2018-11-08)
--------------------
- Update required setuptools version.
- Minor setup and tests improvements.

1.2.0b4 (2018-02-26)
--------------------
- Improve and simplify setup and packaging.

1.2.0b3 (2018-02-01)
--------------------
- Update for PyPCAP 1.2.0.

1.2.0b2 (2017-10-10)
--------------------
- Minor changes.

1.2.0b1 (2017-10-05)
--------------------
- Next beta release.
- Update for PyPCAP 1.2.0rc.

1.1.6b4 (2017-10-04)
--------------------
- Fourth beta release.

1.1.6b3 (2017-08-28)
--------------------
- Third beta release.

1.1.6b2 (2017-08-28)
--------------------
- Second beta release.

1.1.6b1 (2017-08-27)
--------------------
- First beta release.

1.1.6a15 (2017-08-25)
---------------------
- Next alpha release.

1.1.6a0 (2017-06-10)
--------------------
- First alpha release.

0.0.1 (2016-09-23)
------------------
- Initial release.
