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 pullFor local development with pipenv, the repository already includes a Pipfile and Makefile targets that keep both the virtualenv and the package caches inside the project directory:
make setupThis resolves two common local setup issues on macOS/Homebrew installations: pipenv cache permission errors under ~/Library/Caches and lxml builds failing to locate Homebrew’s libxml2/libxslt headers.
If you prefer to run pipenv directly, use the same local cache layout and skip any stale, user-local Pipfile.lock:
PIPENV_VENV_IN_PROJECT=1 \
PIPENV_CACHE_DIR=$PWD/.pipenv-cache \
PIP_CACHE_DIR=$PWD/.pip-cache \
pipenv install --skip-lock --devAnd 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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pypcapkit-1.4.1.tar.gz.
File metadata
- Download URL: pypcapkit-1.4.1.tar.gz
- Upload date:
- Size: 801.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
140ed7c38838de02e11b8929b31762cd8e383c7555758ee3bcf5b056d6428d91
|
|
| MD5 |
9035a1ff8bcda965b10dc3f58d9e4b2f
|
|
| BLAKE2b-256 |
fcdeb056e3ea8290b24359cdbe1655086ead27c1c41ec944eb9bd957ce1249e5
|
File details
Details for the file pypcapkit-1.4.1-pp311-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-pp311-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: PyPy
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ec2bdbe27c3f64b535c4e2349c03f39ee9e94dcdc25eb09457fe1e99ffbeef0
|
|
| MD5 |
62c82c7981d806da1b9909ae51962434
|
|
| BLAKE2b-256 |
4b5329101d9029068f8b560f5476e25f98e5392a02af4ff23e8555e4296ed377
|
File details
Details for the file pypcapkit-1.4.1-pp310-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-pp310-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: PyPy
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6626f784f14a30e0be51413576c21e3d5b075ecbbfc91fe56803a163e00d821e
|
|
| MD5 |
36ccc736341587d95b3ec122dbca23e4
|
|
| BLAKE2b-256 |
b9b7887c0961adff1f7607dc74692d9e39e3f97f42949197eb22b9d61dc1fe13
|
File details
Details for the file pypcapkit-1.4.1-cp314-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-cp314-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: CPython 3.14
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
71caf15ab8b953934ec5a48cff79df2623ce337c11b64f7a821ae7c295bbcc80
|
|
| MD5 |
efa09a353903622e3f1a6671c9942bc4
|
|
| BLAKE2b-256 |
3d5f99598789a95c02afb8a4ab2e4bd701fd1056e38688644a9e77c28b963120
|
File details
Details for the file pypcapkit-1.4.1-cp313-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-cp313-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: CPython 3.13
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
485e883967bb644d3661d77c9c84b17eb1bf809c173ced9b1e14d8af8e27698c
|
|
| MD5 |
5fd130dac1719d0e57a13a7afef8d1f2
|
|
| BLAKE2b-256 |
ff110e428f549fb5ddc0f26d53090c1229e1b7f608a2dfd8e87c0fc92f4c2ec6
|
File details
Details for the file pypcapkit-1.4.1-cp312-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-cp312-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: CPython 3.12
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa9d4b58103e2e93cf7b8465f45511094f4f420cb59a21595d5dac6e2720b56c
|
|
| MD5 |
617ff2cfbe3d11b565ac31f07bf57b92
|
|
| BLAKE2b-256 |
473da9fa36be6850e5f54b31459d0e732899e3b5bec0818249fd6594188373c9
|
File details
Details for the file pypcapkit-1.4.1-cp311-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-cp311-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: CPython 3.11
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88dbeb0d959a101045ba1de4259593adce8e9a906fe66581118e4484499c47bd
|
|
| MD5 |
19883671562329112e28b37d07443225
|
|
| BLAKE2b-256 |
2d42aaba09656001622d1493d47b0c9d9442c25b080d018aebcae0b505900d59
|
File details
Details for the file pypcapkit-1.4.1-cp310-none-any.whl.
File metadata
- Download URL: pypcapkit-1.4.1-cp310-none-any.whl
- Upload date:
- Size: 976.2 kB
- Tags: CPython 3.10
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
466e4d2224952fefaa6025e1b6ef0f1a99aa0d9457eda390995a036683fbf5b5
|
|
| MD5 |
462da6e506634d79d1ba13dd62dc185f
|
|
| BLAKE2b-256 |
df9dc701cfb0d58219d57c997f108ed57508ebbc52108b7a42270d39d3e05d96
|
