For any technical and/or maintenance information, please kindly refer to the Official Documentation.
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
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
Simply run the following to install the current version from PyPI:
pip install pypcapkitOr install the latest version from the gi repository:
git clone https://github.com/JarryShaw/PyPCAPKit.git
cd pypcapkit
pip install -e .
# and to update at any time
git pullAnd since pcapkit supports various extraction engines, and extensive plug-in functions, you may want to install the optional ones:
# 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 pysharkFor CLI usage, you will need to install the optional packages:
pip install pypcapkit[cli]
# or explicitly...
pip install pypcapkit emoji1 maintainer
Metadata
1 maintainer
Release files for pypcapkit 1.3.1.post19
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pypcapkit-1.3.1.post19.tar.gz | 670.7 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pypcapkit-1.3.1.post19-cp312-none-any.whl | CPython 3.12 | none | any | Details |
| pypcapkit-1.3.1.post19-cp311-none-any.whl | CPython 3.11 | none | any | Details |
| pypcapkit-1.3.1.post19-cp39-none-any.whl | CPython 3.9 | none | any | Details |
| pypcapkit-1.3.1.post19-cp38-none-any.whl | CPython 3.8 | none | any | Details |
Total release size: 4.6 MB
Release files / pypcapkit-1.3.1.post19.tar.gz
| Download URL | pypcapkit-1.3.1.post19.tar.gz |
|---|---|
| Size | 670.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd059131bf07fd0e403544cdcdb57d8531462284f9bf822e047c0b5d9069d261
|
|
BLAKE2b-256 checksum How to use checksums |
cff5f3e9578bc20f141c531e4ff7355d3d5cca00e7a9f4528b487a076d2570ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / pypcapkit-1.3.1.post19-cp312-none-any.whl
| Download URL | pypcapkit-1.3.1.post19-cp312-none-any.whl |
|---|---|
| Size | 975.5 kB |
| Tags | CPython 3.12 |
|
SHA-256 checksum How to use checksums |
76e4e098d1485090f6e17666780a56f9ca8c5685451d94e123f5387362513738
|
|
BLAKE2b-256 checksum How to use checksums |
93bca8c976f527a202e809f242cfcec6862d9ee3510308552ec123fe67ee4697
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / pypcapkit-1.3.1.post19-cp311-none-any.whl
| Download URL | pypcapkit-1.3.1.post19-cp311-none-any.whl |
|---|---|
| Size | 975.5 kB |
| Tags | CPython 3.11 |
|
SHA-256 checksum How to use checksums |
8a67a063cf25c5b535fbfd3a94255dd77263621ca81d47e65ec00711482423fb
|
|
BLAKE2b-256 checksum How to use checksums |
1484423e2520e85ef2bf7edcb103c465fdc572e66632b0acb352053dc30c1d9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / pypcapkit-1.3.1.post19-cp39-none-any.whl
| Download URL | pypcapkit-1.3.1.post19-cp39-none-any.whl |
|---|---|
| Size | 975.5 kB |
| Tags | CPython 3.9 |
|
SHA-256 checksum How to use checksums |
5bf8e0dd9fe9e2a071e05b41cd4d654391bff58e95da85d2cf18ac69c5386564
|
|
BLAKE2b-256 checksum How to use checksums |
68a24beda55b9c052489679d8963b27bbce8abcceb444390d4bdd26e9b66dcc9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / pypcapkit-1.3.1.post19-cp38-none-any.whl
| Download URL | pypcapkit-1.3.1.post19-cp38-none-any.whl |
|---|---|
| Size | 975.5 kB |
| Tags | CPython 3.8 |
|
SHA-256 checksum How to use checksums |
b8670be6e06da9fb20ed1877ac3c3f4ed94d1a55113bbb4ac9f3b6555b66f3a3
|
|
BLAKE2b-256 checksum How to use checksums |
0686a82fae4de3769607f066e96728b4b2c7476792d7471b7f67e338548359d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
