Skip to main content

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 pypcapkit

Or 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 pull

And 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 pyshark

For CLI usage, you will need to install the optional packages:

pip install pypcapkit[cli]
# or explicitly...
pip install pypcapkit emoji

Metadata

Release files for pypcapkit 1.3.5.post33

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pypcapkit 1.3.5.post33
File Size Uploaded Provenance
pypcapkit-1.3.5.post33.tar.gz 669.1 kB Without provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for pypcapkit 1.3.5.post33
File
pypcapkit-1.3.5.post33-pp310-none-any.whl PyPy 3.10 none any Details
pypcapkit-1.3.5.post33-pp39-none-any.whl PyPy 3.9 none any Details
pypcapkit-1.3.5.post33-pp38-none-any.whl PyPy 3.8 none any Details
pypcapkit-1.3.5.post33-cp313-none-any.whl CPython 3.13 none any Details
pypcapkit-1.3.5.post33-cp312-none-any.whl CPython 3.12 none any Details
pypcapkit-1.3.5.post33-cp311-none-any.whl CPython 3.11 none any Details
pypcapkit-1.3.5.post33-cp310-none-any.whl CPython 3.10 none any Details
pypcapkit-1.3.5.post33-cp39-none-any.whl CPython 3.9 none any Details

Total release size: 8.5 MB

Release files / pypcapkit-1.3.5.post33.tar.gz

Download URL pypcapkit-1.3.5.post33.tar.gz
Size 669.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9c0a661dcf95cb49876daaf8e3ad9198845627e6bf4178d69e1d2cffade99ef4
BLAKE2b-256 checksum
How to use checksums
82529fa4c7f4a7f0046b97c72bca7637dd71dff600a2e4784501294c19170185
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-pp310-none-any.whl

Download URL pypcapkit-1.3.5.post33-pp310-none-any.whl
Size 973.8 kB
Tags PyPy 3.10
SHA-256 checksum
How to use checksums
8b97baa821d5d03c741c533a5f31aeb287d9c9ec4eaa6d79ef77571b30589060
BLAKE2b-256 checksum
How to use checksums
6f7a893fd4d63418445436e277b45e90fed65aa4ac66beba771da730edfcc932
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-pp39-none-any.whl

Download URL pypcapkit-1.3.5.post33-pp39-none-any.whl
Size 973.8 kB
Tags PyPy 3.9
SHA-256 checksum
How to use checksums
f0ab8f3e152e1a28eed9a8f34a877d6f1cc743c79b156e3a5b71445a121e1b1f
BLAKE2b-256 checksum
How to use checksums
4dbc1cda5d227532c0b23e01fc1717ee8a0cde03be234840046018dd951a901a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-pp38-none-any.whl

Download URL pypcapkit-1.3.5.post33-pp38-none-any.whl
Size 973.8 kB
Tags PyPy 3.8
SHA-256 checksum
How to use checksums
4b8a8b0c26cf1e11f9aff9768fe8461cf668f9ac5f19d0589e020b719a7b8480
BLAKE2b-256 checksum
How to use checksums
145ec6a8d02241cc769d2f3a3fd9fc0bc5b3ff711c519a06131b76d41cc4eab6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-cp313-none-any.whl

Download URL pypcapkit-1.3.5.post33-cp313-none-any.whl
Size 973.8 kB
Tags CPython 3.13
SHA-256 checksum
How to use checksums
36541cb5955a96d0da5bc3efa74f6457fa2ca0d45bf951fe0556c211cf1414af
BLAKE2b-256 checksum
How to use checksums
bbeb0542e9b22dfa208f0f76e971ffb9c7f7dc96259bac7f8e9dfd59261bf3fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-cp312-none-any.whl

Download URL pypcapkit-1.3.5.post33-cp312-none-any.whl
Size 973.8 kB
Tags CPython 3.12
SHA-256 checksum
How to use checksums
9d6b46e7e718dbe62710d7eda690b3d84c0cf8c74c9c1130dc84a0a0a3e46280
BLAKE2b-256 checksum
How to use checksums
0e0b45cd969e7744e0846bc11b1af6ec256c2b3e9a436d7c86fd885f6d3c6330
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-cp311-none-any.whl

Download URL pypcapkit-1.3.5.post33-cp311-none-any.whl
Size 973.8 kB
Tags CPython 3.11
SHA-256 checksum
How to use checksums
f46569eb65bcacf2a70627289f0ea72b6f8a5eed8b51cb43a67bb32de16358ff
BLAKE2b-256 checksum
How to use checksums
fe9b7a46316360443bc16bb3e640549411c897aa2af0ea98729e661b07a7e639
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-cp310-none-any.whl

Download URL pypcapkit-1.3.5.post33-cp310-none-any.whl
Size 973.8 kB
Tags CPython 3.10
SHA-256 checksum
How to use checksums
69b34a22424417765aa9eae1851efe07492c8a13a02f58a44c96910bcced4f08
BLAKE2b-256 checksum
How to use checksums
bf669b5baf5be25d8753844851cab4819b9c70365200862603833be37c8645f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pypcapkit-1.3.5.post33-cp39-none-any.whl

Download URL pypcapkit-1.3.5.post33-cp39-none-any.whl
Size 973.8 kB
Tags CPython 3.9
SHA-256 checksum
How to use checksums
5f6792a649ba09807306bbc3707ec3fde51bb95759a8c70c5c6002a2a16da29a
BLAKE2b-256 checksum
How to use checksums
216627382a073431ea7de43a0d36075d5ad3e2bb20e315d3816b04c0e7b8fec4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Security for pypcapkit 1.3.5.post33

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page