| Name | pypcapkit JSON |
| Version |
1.3.1.post9
JSON |
| download |
| home_page | None |
| Summary | PyPCAPKit: comprehensive network packet analysis library |
| upload_time | 2024-03-30 10:12:55 |
| maintainer | Jarry Shaw |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.6 |
| license | BSD 3-Clause License |
| keywords |
network
pcap
packet
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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/c6/1b/f3eb3fd7cda9dedd6b750c2aeefd6d0600b291228857c21c99d81d069f3d/pypcapkit-1.3.1.post9.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.1.post9",
"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": "",
"digests": {
"blake2b_256": "6cf90cb8da5a8b865d1b093cfa2bca1383e6575dd8b9ac75b056eb21ede6f970",
"md5": "7c4c8b6a473d88ed30aa7853c0f5be80",
"sha256": "9d7b5ba09aa0bbe5f383abad44681e3494313d6cf85021b8473f8fe8059d16ad"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-cp310-none-any.whl",
"has_sig": false,
"md5_digest": "7c4c8b6a473d88ed30aa7853c0f5be80",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:13:03",
"upload_time_iso_8601": "2024-03-30T10:13:03.766459Z",
"url": "https://files.pythonhosted.org/packages/6c/f9/0cb8da5a8b865d1b093cfa2bca1383e6575dd8b9ac75b056eb21ede6f970/pypcapkit-1.3.1.post9-cp310-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64519032b6e43d6cae33ff2aec5ba3b2df60b9efdeb85ed98e22cddaa1b36c30",
"md5": "81167ad00f41b000e4a1d7196abadc14",
"sha256": "21462fdd45346cc9ce39af0d749bd2525bbf19646573d4262cca14d4c74bb7f8"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-cp311-none-any.whl",
"has_sig": false,
"md5_digest": "81167ad00f41b000e4a1d7196abadc14",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:12:51",
"upload_time_iso_8601": "2024-03-30T10:12:51.389491Z",
"url": "https://files.pythonhosted.org/packages/64/51/9032b6e43d6cae33ff2aec5ba3b2df60b9efdeb85ed98e22cddaa1b36c30/pypcapkit-1.3.1.post9-cp311-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74ed910f38415165844bb066949859ed6fbe4dc9aaef741d9fe18c955bebc526",
"md5": "35c2b604535d7a933129a80820aac11a",
"sha256": "5d51f580cf812af25048aae2f63f767c01964e8f00493c529b10d838e9cc1696"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-cp38-none-any.whl",
"has_sig": false,
"md5_digest": "35c2b604535d7a933129a80820aac11a",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:12:53",
"upload_time_iso_8601": "2024-03-30T10:12:53.148245Z",
"url": "https://files.pythonhosted.org/packages/74/ed/910f38415165844bb066949859ed6fbe4dc9aaef741d9fe18c955bebc526/pypcapkit-1.3.1.post9-cp38-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0cd21cd7ff2c437e64d49153e3cf568da1b50f759e83cf270bc40e9ae60e742",
"md5": "a551b01650f17f2e459207d1ac3dec06",
"sha256": "8d3674f636563404d3051e96da29cdf69e9d3c23a854117b26b17726a65efa07"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-cp39-none-any.whl",
"has_sig": false,
"md5_digest": "a551b01650f17f2e459207d1ac3dec06",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:12:53",
"upload_time_iso_8601": "2024-03-30T10:12:53.599362Z",
"url": "https://files.pythonhosted.org/packages/b0/cd/21cd7ff2c437e64d49153e3cf568da1b50f759e83cf270bc40e9ae60e742/pypcapkit-1.3.1.post9-cp39-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37ed5d96908e931a447dd6f0b8317fa41c03868e804b62deb5595c022f313347",
"md5": "d1192a3bbf91c261ca3ab9293216aa12",
"sha256": "a718c111eaa30704362bc97af4d65d9f3e2aff33b942ec567c5fa4649c2a37ef"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-pp38-none-any.whl",
"has_sig": false,
"md5_digest": "d1192a3bbf91c261ca3ab9293216aa12",
"packagetype": "bdist_wheel",
"python_version": "pp38",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:13:08",
"upload_time_iso_8601": "2024-03-30T10:13:08.598695Z",
"url": "https://files.pythonhosted.org/packages/37/ed/5d96908e931a447dd6f0b8317fa41c03868e804b62deb5595c022f313347/pypcapkit-1.3.1.post9-pp38-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee448f27d4d0089bbf57843fda57fc7f9dbb1ab0e13b65355fe27476c0ad621c",
"md5": "9c5a11423056300c3e3f9401fe5053db",
"sha256": "d544eb1f07ed8d22d192cef655413c8883776bceceedd8188e14a91eb57d63d2"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9-pp39-none-any.whl",
"has_sig": false,
"md5_digest": "9c5a11423056300c3e3f9401fe5053db",
"packagetype": "bdist_wheel",
"python_version": "pp39",
"requires_python": "<4,>=3.6",
"size": 975902,
"upload_time": "2024-03-30T10:13:12",
"upload_time_iso_8601": "2024-03-30T10:13:12.111033Z",
"url": "https://files.pythonhosted.org/packages/ee/44/8f27d4d0089bbf57843fda57fc7f9dbb1ab0e13b65355fe27476c0ad621c/pypcapkit-1.3.1.post9-pp39-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c61bf3eb3fd7cda9dedd6b750c2aeefd6d0600b291228857c21c99d81d069f3d",
"md5": "2501a5f50f1e984f71976608f54b8a44",
"sha256": "3337b5c87ff2d7ae377454dc41123796721c5901972ff67b93b79147e324e4a5"
},
"downloads": -1,
"filename": "pypcapkit-1.3.1.post9.tar.gz",
"has_sig": false,
"md5_digest": "2501a5f50f1e984f71976608f54b8a44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 671148,
"upload_time": "2024-03-30T10:12:55",
"upload_time_iso_8601": "2024-03-30T10:12:55.028460Z",
"url": "https://files.pythonhosted.org/packages/c6/1b/f3eb3fd7cda9dedd6b750c2aeefd6d0600b291228857c21c99d81d069f3d/pypcapkit-1.3.1.post9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 10:12:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JarryShaw",
"github_project": "PyPCAPKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pypcapkit"
}
