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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypcapkit-1.3.5.post43.tar.gz (671.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pypcapkit-1.3.5.post43-pp311-none-any.whl (974.8 kB view details)

Uploaded PyPy

pypcapkit-1.3.5.post43-pp310-none-any.whl (974.8 kB view details)

Uploaded PyPy

pypcapkit-1.3.5.post43-cp314-none-any.whl (974.8 kB view details)

Uploaded CPython 3.14

pypcapkit-1.3.5.post43-cp311-none-any.whl (974.8 kB view details)

Uploaded CPython 3.11

pypcapkit-1.3.5.post43-cp310-none-any.whl (974.8 kB view details)

Uploaded CPython 3.10

File details

Details for the file pypcapkit-1.3.5.post43.tar.gz.

File metadata

  • Download URL: pypcapkit-1.3.5.post43.tar.gz
  • Upload date:
  • Size: 671.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pypcapkit-1.3.5.post43.tar.gz
Algorithm Hash digest
SHA256 e37db8fc775056548bfcd1a19897fdb9c3c3e05efbfef558fd33bc79f92bd0a1
MD5 65569be3059fad869425ac7237b8d3d6
BLAKE2b-256 c5ce6aab7933488d6c5599f484dab3407e7603441d259081d0c16c54f808251f

See more details on using hashes here.

File details

Details for the file pypcapkit-1.3.5.post43-pp311-none-any.whl.

File metadata

File hashes

Hashes for pypcapkit-1.3.5.post43-pp311-none-any.whl
Algorithm Hash digest
SHA256 79150aba6d820a9c2e940ae30b52fdbb826ff4114fe3487e6a884c8508b8fc55
MD5 01d98a0a9fac380622f192394c82cfee
BLAKE2b-256 449b1f28bcb0317b0b8c346a14c0dc845e567cd3d943e22bf34b55a8f640aa55

See more details on using hashes here.

File details

Details for the file pypcapkit-1.3.5.post43-pp310-none-any.whl.

File metadata

File hashes

Hashes for pypcapkit-1.3.5.post43-pp310-none-any.whl
Algorithm Hash digest
SHA256 a1ec9931f6ae0817c9bf825d6740b7fef9faf4cedf45b2f22e283b17880dd378
MD5 45be1f6ce772db12866a1cfaaf87b80b
BLAKE2b-256 772c3057681c6a2218a028402ac9ebb3d0deb22426a767e65835d9ba16e46d5f

See more details on using hashes here.

File details

Details for the file pypcapkit-1.3.5.post43-cp314-none-any.whl.

File metadata

File hashes

Hashes for pypcapkit-1.3.5.post43-cp314-none-any.whl
Algorithm Hash digest
SHA256 6208141e0fec7a59712094eea659744270763c0ebb47a06b1b4779182fcb970d
MD5 cd3227d807f7f71973d7ce32c58f5dff
BLAKE2b-256 4064d9d810f8151be0025a9cc79ec429f03af02bca79c087e781cf2990aae57f

See more details on using hashes here.

File details

Details for the file pypcapkit-1.3.5.post43-cp311-none-any.whl.

File metadata

File hashes

Hashes for pypcapkit-1.3.5.post43-cp311-none-any.whl
Algorithm Hash digest
SHA256 0c6436c2729b6d15b1b5579950f8425538c198b777cb378d23dfaaaa14346223
MD5 278cabe6a4b4e2141d7918fc19d2aa0f
BLAKE2b-256 54d8cfa753164f6a75e3ea18284cedd2c5e369e3d3530f8435fc8dc1b47b360d

See more details on using hashes here.

File details

Details for the file pypcapkit-1.3.5.post43-cp310-none-any.whl.

File metadata

File hashes

Hashes for pypcapkit-1.3.5.post43-cp310-none-any.whl
Algorithm Hash digest
SHA256 c46d7038d1a716b8e9604651cbb26ba366351a030159117b208e82ab7d9fe900
MD5 aa6e21ada248dea7b1073e09d228e1e3
BLAKE2b-256 649bd72db6ade3884c166a1aa26f0499157926897e75737d923d02ad8e99136c

See more details on using hashes here.

Release history Release notifications | RSS feed

1.4.1

8 files

1.4.0

8 files

This release

1.3.5.post43 This release

6 files

1.3.5.post42

7 files

1.3.5.post41

7 files

1.3.5.post40

8 files

1.3.5.post39

7 files

1.3.5.post38

8 files

1.3.5.post37

9 files

1.3.5.post36

8 files

1.3.5.post35

9 files

1.3.5.post34

7 files

1.3.5.post33

9 files

1.3.5.post32

9 files

1.3.5.post31

8 files

1.3.5.post30

9 files

1.3.5.post29

8 files

1.3.5.post28

9 files

1.3.5.post27

6 files

1.3.5.post26

6 files

1.3.5.post25

5 files

1.3.5.post24

9 files

1.3.5.post22

5 files

1.3.5.post21

8 files

1.3.5.post20

4 files

1.3.5.post19

6 files

1.3.5.post18

7 files

1.3.5.post17

8 files

1.3.5.post16

4 files

1.3.5.post15

5 files

1.3.5.post14

9 files

1.3.5.post13

4 files

1.3.5.post12

4 files

1.3.5.post11

4 files

1.3.5.post10

4 files

1.3.5.post9

3 files

1.3.5.post8

4 files

1.3.5.post7

3 files

1.3.5.post6

9 files

1.3.5.post5

7 files

1.3.5.post4

5 files

1.3.5.post3

8 files

1.3.5.post2

4 files

1.3.5.post1

9 files

1.3.5

8 files

1.3.4

9 files

1.3.3.post2

9 files

1.3.3.post1

9 files

1.3.3

7 files

1.3.1.post28

9 files

1.3.1.post27

8 files

1.3.1.post26

5 files

1.3.1.post25

3 files

1.3.1.post24

9 files

1.3.1.post23

4 files

1.3.1.post22

4 files

1.3.1.post21

7 files

1.3.1.post20

9 files

1.3.1.post19

5 files

1.3.1.post18

9 files

1.3.1.post9

7 files

1.3.1.post8

7 files

1.3.1.post7

6 files

1.3.1.post6

7 files

1.3.1.post5

7 files

1.3.1.post4

6 files

1.3.1.post3

7 files

1.3.1.post2

7 files

1.3.1.post1

7 files

1.3.1

6 files

1.3.0

7 files

1.2.2.post2

7 files

1.2.2.post1

7 files

1.2.2

6 files

1.2.1.post3

7 files

1.2.1.post2

7 files

1.2.1.post1

7 files

1.2.1

7 files

1.2.0

7 files

1.1.1.post2

7 files

1.1.1.post1

7 files

1.1.1

7 files

1.1.0.post3

7 files

1.1.0.post2

6 files

1.1.0.post1

7 files

1.1.0

7 files

1.0.3.post3

6 files

1.0.3.post2

6 files

1.0.3.post1

6 files

1.0.3

6 files

1.0.2.post8

7 files

1.0.2.post7

7 files

1.0.2.post6

7 files

1.0.2.post5

6 files

1.0.2.post4

7 files

1.0.2.post3

6 files

1.0.2.post2

7 files

1.0.2.post1

9 files

1.0.2

5 files

1.0.1.post3

2 files

1.0.1.post2

2 files

1.0.1.post1

2 files

1.0.1

2 files

1.0.0

2 files

0.16.3

14 files

0.16.2

1 file

0.16.1

1 file

0.16.0

1 file

0.15.5

2 files

0.15.4.post1

2 files

0.15.4

2 files

0.15.3

2 files

0.15.2

2 files

0.15.1.post1

2 files

0.15.1

2 files

0.15.0

2 files

0.14.5

13 files

0.14.4

13 files

0.14.3

13 files

0.13.3.post2

15 files

0.13.3.post1

15 files

0.13.3

15 files

0.13.2

10 files

0.13.1

10 files

0.13.0.post2

10 files

0.13.0.post1

10 files

0.13.0

10 files

0.12.11

10 files

0.12.10.post2

10 files

0.12.10.post1

10 files

0.12.10

9 files

0.12.9.post5

9 files

0.12.9.post4

5 files

0.12.9.post3

5 files

0.12.9.post2

3 files

0.12.9.post1

3 files

0.12.9

3 files

0.12.8

3 files

0.12.7

3 files

0.12.6.post1

3 files

0.12.6

3 files

0.12.5.post1

3 files

0.12.5

2 files

0.12.4

2 files

0.12.3

2 files

0.12.2

2 files

0.12.1

2 files

0.12.0.post4

2 files

0.12.0.post3

2 files

0.12.0.post2

2 files

0.12.0.post1

2 files

0.12.0

2 files

0.11.3

2 files

0.11.2

2 files

0.11.1

2 files

0.11.0

2 files

0.10.5

2 files

0.10.4

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1.post1

2 files

0.10.1

2 files

0.10.0

2 files

0.9.10.post1

2 files

0.9.10

2 files

0.9.9.post1

2 files

0.9.9

2 files

0.9.8

2 files

0.9.7.post1

2 files

0.9.7

2 files

0.9.6.post2

2 files

0.9.6.post1

2 files

0.9.6

2 files

0.9.5.post2

2 files

0.9.5.post1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page