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.post32

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.post32
File Size Uploaded Provenance
pypcapkit-1.3.5.post32.tar.gz 669.1 kB Without provenance Details

Built distributions (wheels)

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

Total release size: 8.5 MB

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

Download URL pypcapkit-1.3.5.post32.tar.gz
Size 669.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c14b1fbe1c10ed9df5babf2e199481c86733209f1de27610b0a739078d8b597f
BLAKE2b-256 checksum
How to use checksums
426b8649bf907b050036ea97eeca808c83c1efb7656805ad73d48bc75b772982
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.post32-pp310-none-any.whl

Download URL pypcapkit-1.3.5.post32-pp310-none-any.whl
Size 973.8 kB
Tags PyPy 3.10
SHA-256 checksum
How to use checksums
916c542e28afd44ca920a3df53cf2fd005d04910e4693e93f6abe7bdf6fabd87
BLAKE2b-256 checksum
How to use checksums
4eac49bcfe09680a6a7b0333053f3ed4293b056eddb11a68bfc939a037fed4dd
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.post32-pp39-none-any.whl

Download URL pypcapkit-1.3.5.post32-pp39-none-any.whl
Size 973.8 kB
Tags PyPy 3.9
SHA-256 checksum
How to use checksums
890cb20b87aea399d1ae0f34f9aedc9f805c7a84ccc0e37115d2322e686bdfb7
BLAKE2b-256 checksum
How to use checksums
0d347dd95aaa98bef94276c8b7aae43a0a8b60218199a16b51c51f9371c93756
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.post32-pp38-none-any.whl

Download URL pypcapkit-1.3.5.post32-pp38-none-any.whl
Size 973.8 kB
Tags PyPy 3.8
SHA-256 checksum
How to use checksums
bdffc39cad0de6f8826c42e03c366a8438e6ce4ade9eb690225862c722186fdb
BLAKE2b-256 checksum
How to use checksums
2b41a678d1de171527e386fc5b4d563dc106bd4024ac44da23024c50e7f736ce
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.post32-cp313-none-any.whl

Download URL pypcapkit-1.3.5.post32-cp313-none-any.whl
Size 973.8 kB
Tags CPython 3.13
SHA-256 checksum
How to use checksums
cc225bffe9d62f58b203e686660038b838cca5589669af5ff01f1a07eb8abc6a
BLAKE2b-256 checksum
How to use checksums
f42f6f67d85112b7615d67d2f937b3bca1f932d79231573fdec3e5aa80d91598
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.post32-cp312-none-any.whl

Download URL pypcapkit-1.3.5.post32-cp312-none-any.whl
Size 973.8 kB
Tags CPython 3.12
SHA-256 checksum
How to use checksums
efbcd7d2bc0fab7fa25f7c812a4167dff1230f0066564352ffa905285a96c558
BLAKE2b-256 checksum
How to use checksums
880249ad14a1603dde9c218aa36b523959e5dba9778d98749496f5b1affce51e
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.post32-cp311-none-any.whl

Download URL pypcapkit-1.3.5.post32-cp311-none-any.whl
Size 973.8 kB
Tags CPython 3.11
SHA-256 checksum
How to use checksums
7e17af102f85ef9fe8744c731f5e661da16c2bc1d581691a2129fa716c6cfb59
BLAKE2b-256 checksum
How to use checksums
edec9a03fe3b4d15f2acaedf1260944e3f748a8f77c005ab42598a77cf198914
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.post32-cp310-none-any.whl

Download URL pypcapkit-1.3.5.post32-cp310-none-any.whl
Size 973.8 kB
Tags CPython 3.10
SHA-256 checksum
How to use checksums
98d3efc61ebf00602864fb06d996e4efdecb8f2e1ad0329c2b0a63330399c86a
BLAKE2b-256 checksum
How to use checksums
c96ba6776ada4c9ecf58e3a69396c43128b9901386ba41743ffb13215cf646cb
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.post32-cp39-none-any.whl

Download URL pypcapkit-1.3.5.post32-cp39-none-any.whl
Size 973.8 kB
Tags CPython 3.9
SHA-256 checksum
How to use checksums
077f5db72dced3b03f164c3de993b56f2616bc0e8491172bfe02aa91e8a32e94
BLAKE2b-256 checksum
How to use checksums
96bd47cd68678ba0bf11dc326f84951226c09387a302ab6d82db394098d347a1
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.post32

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