Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dpkt readme needs to explain what the package does #526

Open
brifordwylie opened this issue Jan 8, 2021 · 1 comment
Open

dpkt readme needs to explain what the package does #526

brifordwylie opened this issue Jan 8, 2021 · 1 comment

Comments

@brifordwylie
Copy link
Collaborator

brifordwylie commented Jan 8, 2021

@obormot @kbandla so I noticed that the Readme has no explaining for what dpkt is/does. So shrug... I start a strawman and you guys can add/improve.

Adding some feedback from obormot..

"The dpkt package is a lightweight Python for network packet parsing and unpacking. Dpkt processes packets individually as a stream and is therefore fast and memory efficient. Since dpkt focuses on individual packets it does NOT provide reassembly functionality (like full HTTP requests/responses)."

Shrug.. please feel free to improve this ^

@obormot
Copy link
Collaborator

obormot commented Jan 8, 2021

...and what it does NOT too! E.g. we get many repeated issues/questions on ip/tcp/etc. stream reassembly or things that require underlying reassembly (like full HTTP requests/responses).
Also I suggest establishing guidelines for submitting issues - e.g. if it's a pcap failure, always attach the pcap and the piece of code that fails with explanation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants