PyPCAPKit - Comprehensive Network Packet Analysis Library
=========================================================
For any technical and/or maintenance information,
please kindly refer to the |docs|_.
.. |docs| replace:: **Official Documentation**
.. _docs: https://jarryshaw.github.io/PyPCAPKit/
The PyPCAPKit project is an open source Python program focus on network packet
parsing and analysis, which works as a comprehensive `PCAP`_ file extraction,
construction and analysis library.
The whole project supports **Python 3.6** or later.
-----
About
-----
PyPCAPKit is a comprehensive Python-native network packet analysis library,
with `DictDumper`_ as its formatted output dumper.
Unlike popular PCAP file extractors, such as `Scapy`_, `DPKT`_, `PyShark`_,
and etc, ``pcapkit`` is designed to be much more comprehensive, which means
it is able to provide more detailed information about the packet, as well as
a more *Pythonic* interface for users to interact with.
Module Structure
----------------
In ``pcapkit``, all files can be described as following eight parts.
- Interface (``pcapkit.interface``)
User interface for the ``pcapkit`` library, which
standardises and simplifies the usage of this library.
- Foundation (``pcapkit.foundation``)
Synthesises file I/O and protocol analysis, coordinates
information exchange in all network layers, as well as
provides the foundamental functions for ``pcapkit``.
- Protocols (``pcapkit.protocols``)
Collection of all protocol family, with detailed
implementation and methods.
- Utilities (``pcapkit.utilities``)
Auxiliary functions and tools for ``pcapkit``.
- CoreKit (``pcapkit.corekit``)
Core utilities for ``pcapkit`` implementation, mainly
for internal data structure and processing.
- ToolKit (``pcapkit.toolkit``)
Auxiliary tools for ``pcapkit`` to support the multiple
extraction engines with a unified interface.
- DumpKit (``pcapkit.dumpkit``)
File output formatters for ``pcapkit``.
- Constants (``pcapkit.const``)
Constant enumerations used in ``pcapkit`` for protocol
family extraction and representation.
Engine Comparison
-----------------
Due to the general overhead of ``pcapkit``, its extraction procedure takes
around *0.2* milliseconds per packet, which is already impressive but not enough
comparing to other popular extration engines availbale on the market, given the
fact that ``pcapkit`` is a **comprehensive** packet processing module.
Additionally, ``pcapkit`` introduced alternative extractionengines to accelerate
this procedure. By now ``pcapkit`` supports `Scapy`_, `DPKT`_, and `PyShark`_.
Test Environment
~~~~~~~~~~~~~~~~
.. list-table::
* - Operating System
- macOS Ventura 13.4.1
* - Chip
- Apple M2 Pro
* - Memory
- 16 GB
Test Results
~~~~~~~~~~~~
============= ===========================
Engine Performance (ms per packet)
============= ===========================
``dpkt`` 0.010390_056723
``scapy`` 0.091690_233567
``pcapkit`` 0.200390_390390
``pyshark`` 24.682185_018351
============= ===========================
------------
Installation
------------
.. note::
``pcapkit`` supports Python versions **since 3.6**.
Simply run the following to install the current version from PyPI:
.. code-block:: shell
pip install pypcapkit
Or install the latest version from the gi repository:
.. code-block:: shell
git clone https://github.com/JarryShaw/PyPCAPKit.git
cd pypcapkit
pip install -e .
# and to update at any time
git pull
And since ``pcapkit`` supports various extraction engines, and extensive
plug-in functions, you may want to install the optional ones:
.. code-block:: shell
# for DPKT only
pip install pypcapkit[DPKT]
# for Scapy only
pip install pypcapkit[Scapy]
# for PyShark only
pip install pypcapkit[PyShark]
# and to install all the optional packages
pip install pypcapkit[all]
# or to do this explicitly
pip install pypcapkit dpkt scapy pyshark
For CLI usage, you will need to install the optional packages:
.. code-block:: shell
pip install pypcapkit[cli]
# or explicitly...
pip install pypcapkit emoji
.. _PCAP: https://en.wikipedia.org/wiki/Pcap
.. _Scapy: https://scapy.net
.. _DPKT: https://dpkt.readthedocs.io
.. _PyShark: https://kiminewt.github.io/pyshark
.. _DictDumper: https://github.com/JarryShaw/DictDumper
Raw data
{
"_id": null,
"home_page": null,
"name": "pypcapkit",
"maintainer": "Jarry Shaw",
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": null,
"keywords": "network, pcap, packet",
"author": null,
"author_email": "Jarry Shaw <jarryshaw@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/63/48/6e5f8642584caa10ee6cc9dfc41d96cab409398d63ea045c5a4cfe010d16/pypcapkit-1.3.5.post27.tar.gz",
"platform": null,
"description": "PyPCAPKit - Comprehensive Network Packet Analysis Library\n=========================================================\n\n For any technical and/or maintenance information,\n please kindly refer to the |docs|_.\n\n.. |docs| replace:: **Official Documentation**\n.. _docs: https://jarryshaw.github.io/PyPCAPKit/\n\nThe PyPCAPKit project is an open source Python program focus on network packet\nparsing and analysis, which works as a comprehensive `PCAP`_ file extraction,\nconstruction and analysis library.\n\n The whole project supports **Python 3.6** or later.\n\n-----\nAbout\n-----\n\nPyPCAPKit is a comprehensive Python-native network packet analysis library,\nwith `DictDumper`_ as its formatted output dumper.\n\nUnlike popular PCAP file extractors, such as `Scapy`_, `DPKT`_, `PyShark`_,\nand etc, ``pcapkit`` is designed to be much more comprehensive, which means\nit is able to provide more detailed information about the packet, as well as\na more *Pythonic* interface for users to interact with.\n\nModule Structure\n----------------\n\nIn ``pcapkit``, all files can be described as following eight parts.\n\n- Interface (``pcapkit.interface``)\n\n User interface for the ``pcapkit`` library, which\n standardises and simplifies the usage of this library.\n\n- Foundation (``pcapkit.foundation``)\n\n Synthesises file I/O and protocol analysis, coordinates\n information exchange in all network layers, as well as\n provides the foundamental functions for ``pcapkit``.\n\n- Protocols (``pcapkit.protocols``)\n\n Collection of all protocol family, with detailed\n implementation and methods.\n\n- Utilities (``pcapkit.utilities``)\n\n Auxiliary functions and tools for ``pcapkit``.\n\n- CoreKit (``pcapkit.corekit``)\n\n Core utilities for ``pcapkit`` implementation, mainly\n for internal data structure and processing.\n\n- ToolKit (``pcapkit.toolkit``)\n\n Auxiliary tools for ``pcapkit`` to support the multiple\n extraction engines with a unified interface.\n\n- DumpKit (``pcapkit.dumpkit``)\n\n File output formatters for ``pcapkit``.\n\n- Constants (``pcapkit.const``)\n\n Constant enumerations used in ``pcapkit`` for protocol\n family extraction and representation.\n\nEngine Comparison\n-----------------\n\nDue to the general overhead of ``pcapkit``, its extraction procedure takes\naround *0.2* milliseconds per packet, which is already impressive but not enough\ncomparing to other popular extration engines availbale on the market, given the\nfact that ``pcapkit`` is a **comprehensive** packet processing module.\n\nAdditionally, ``pcapkit`` introduced alternative extractionengines to accelerate\nthis procedure. By now ``pcapkit`` supports `Scapy`_, `DPKT`_, and `PyShark`_.\n\nTest Environment\n~~~~~~~~~~~~~~~~\n\n.. list-table::\n\n * - Operating System\n - macOS Ventura 13.4.1\n * - Chip\n - Apple M2 Pro\n * - Memory\n - 16 GB\n\nTest Results\n~~~~~~~~~~~~\n\n============= ===========================\nEngine Performance (ms per packet)\n============= ===========================\n``dpkt`` 0.010390_056723\n``scapy`` 0.091690_233567\n``pcapkit`` 0.200390_390390\n``pyshark`` 24.682185_018351\n============= ===========================\n\n------------\nInstallation\n------------\n\n.. note::\n\n ``pcapkit`` supports Python versions **since 3.6**.\n\nSimply run the following to install the current version from PyPI:\n\n.. code-block:: shell\n\n pip install pypcapkit\n\nOr install the latest version from the gi repository:\n\n.. code-block:: shell\n\n git clone https://github.com/JarryShaw/PyPCAPKit.git\n cd pypcapkit\n pip install -e .\n # and to update at any time\n git pull\n\nAnd since ``pcapkit`` supports various extraction engines, and extensive\nplug-in functions, you may want to install the optional ones:\n\n.. code-block:: shell\n\n # for DPKT only\n pip install pypcapkit[DPKT]\n # for Scapy only\n pip install pypcapkit[Scapy]\n # for PyShark only\n pip install pypcapkit[PyShark]\n # and to install all the optional packages\n pip install pypcapkit[all]\n # or to do this explicitly\n pip install pypcapkit dpkt scapy pyshark\n\nFor CLI usage, you will need to install the optional packages:\n\n.. code-block:: shell\n\n pip install pypcapkit[cli]\n # or explicitly...\n pip install pypcapkit emoji\n\n.. _PCAP: https://en.wikipedia.org/wiki/Pcap\n.. _Scapy: https://scapy.net\n.. _DPKT: https://dpkt.readthedocs.io\n.. _PyShark: https://kiminewt.github.io/pyshark\n.. _DictDumper: https://github.com/JarryShaw/DictDumper\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "PyPCAPKit: comprehensive network packet analysis library",
"version": "1.3.5.post27",
"project_urls": {
"changelog": "https://github.com/JarryShaw/PyPCAPKit/releases",
"documentation": "https://jarryshaw.github.io/PyPCAPKit/",
"homepage": "https://jarryshaw.github.io/PyPCAPKit/",
"repository": "https://github.com/JarryShaw/PyPCAPKit"
},
"split_keywords": [
"network",
" pcap",
" packet"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d01cd4e6ca32f72fc4c47e3b47b67a141b7d8dc6c977c09f31b5812b6c70c32c",
"md5": "8e62d7f4fdb7da850f3d1ae42c57f922",
"sha256": "0a23f93c69aaaf77052cef581dd02c9df58f3838bd5fbc2aa26daf9c1a2418b2"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27-cp310-none-any.whl",
"has_sig": false,
"md5_digest": "8e62d7f4fdb7da850f3d1ae42c57f922",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "<4,>=3.6",
"size": 973593,
"upload_time": "2025-09-06T10:07:29",
"upload_time_iso_8601": "2025-09-06T10:07:29.315159Z",
"url": "https://files.pythonhosted.org/packages/d0/1c/d4e6ca32f72fc4c47e3b47b67a141b7d8dc6c977c09f31b5812b6c70c32c/pypcapkit-1.3.5.post27-cp310-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "46dd8a4b58011ce026b8132cd29afcd31632772a3e396335c242a11fca2764f3",
"md5": "14698d0c7adebce494f60a21f9118eeb",
"sha256": "f0df16b53831197f951ddbec37564b7ae5eeb174988fed8c133772a0e574e51d"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27-cp312-none-any.whl",
"has_sig": false,
"md5_digest": "14698d0c7adebce494f60a21f9118eeb",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "<4,>=3.6",
"size": 973593,
"upload_time": "2025-09-06T10:07:25",
"upload_time_iso_8601": "2025-09-06T10:07:25.581668Z",
"url": "https://files.pythonhosted.org/packages/46/dd/8a4b58011ce026b8132cd29afcd31632772a3e396335c242a11fca2764f3/pypcapkit-1.3.5.post27-cp312-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "baafcce5dccc0eae1d47905998ec7be2700722b30d6aeb1d81ba78e31253595f",
"md5": "16fdd2629ef13d5cdae687dc901c6145",
"sha256": "31b36860bf8d9c947ea27a02553757ab66319088e13e6a03e84b64e6d0e7d257"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27-cp313-none-any.whl",
"has_sig": false,
"md5_digest": "16fdd2629ef13d5cdae687dc901c6145",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": "<4,>=3.6",
"size": 973593,
"upload_time": "2025-09-06T10:07:23",
"upload_time_iso_8601": "2025-09-06T10:07:23.901384Z",
"url": "https://files.pythonhosted.org/packages/ba/af/cce5dccc0eae1d47905998ec7be2700722b30d6aeb1d81ba78e31253595f/pypcapkit-1.3.5.post27-cp313-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "db286c95a655885e00cf35fcb04498d109c9baf802768d25d7c3c2e5abfcec17",
"md5": "443f3e614a01af2ca2f7bc3c2a1f4bda",
"sha256": "bcf8810e03f78c5c768299fc47ea0ba70fee3e43ca8cf1ce78c6b28e0bd4eb48"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27-cp39-none-any.whl",
"has_sig": false,
"md5_digest": "443f3e614a01af2ca2f7bc3c2a1f4bda",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "<4,>=3.6",
"size": 973593,
"upload_time": "2025-09-06T10:07:30",
"upload_time_iso_8601": "2025-09-06T10:07:30.209882Z",
"url": "https://files.pythonhosted.org/packages/db/28/6c95a655885e00cf35fcb04498d109c9baf802768d25d7c3c2e5abfcec17/pypcapkit-1.3.5.post27-cp39-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eb7d849028011de910116af6448dc1fbceb4fccbe9575e7660ba79b21ce7aeac",
"md5": "5d6ebd414d7b574428ab2062491028b7",
"sha256": "82468414bfcaff08fe41162dd1286eb66e7f371a7641453ec94a212880fbdcf2"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27-pp39-none-any.whl",
"has_sig": false,
"md5_digest": "5d6ebd414d7b574428ab2062491028b7",
"packagetype": "bdist_wheel",
"python_version": "pp39",
"requires_python": "<4,>=3.6",
"size": 973593,
"upload_time": "2025-09-06T10:07:36",
"upload_time_iso_8601": "2025-09-06T10:07:36.800420Z",
"url": "https://files.pythonhosted.org/packages/eb/7d/849028011de910116af6448dc1fbceb4fccbe9575e7660ba79b21ce7aeac/pypcapkit-1.3.5.post27-pp39-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "63486e5f8642584caa10ee6cc9dfc41d96cab409398d63ea045c5a4cfe010d16",
"md5": "b5da49ec9ece180e30a2d8d06577c4ca",
"sha256": "f11a7b6a4e46c2fe6cb2c5fae6ad137a167eebe0766d6d3a059d771b45afba1c"
},
"downloads": -1,
"filename": "pypcapkit-1.3.5.post27.tar.gz",
"has_sig": false,
"md5_digest": "b5da49ec9ece180e30a2d8d06577c4ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 668902,
"upload_time": "2025-09-06T10:07:25",
"upload_time_iso_8601": "2025-09-06T10:07:25.709750Z",
"url": "https://files.pythonhosted.org/packages/63/48/6e5f8642584caa10ee6cc9dfc41d96cab409398d63ea045c5a4cfe010d16/pypcapkit-1.3.5.post27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-06 10:07:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JarryShaw",
"github_project": "PyPCAPKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pypcapkit"
}
JSON
