mirror of https://github.com/kbandla/dpkt.git
refactor readme(md/rst) to be shorter, also additional badges fixes
This commit is contained in:
Brian Wylie
parent
c74f010291
commit
225f84b4ce
62
README.md
62
README.md
|
|
@ -1,20 +1,19 @@
|
|||
dpkt
|
||||
====
|
||||
|
||||
fast, simple packet creation / parsing, with definitions for the basic
|
||||
TCP/IP protocols
|
||||
**A fast, simple packet creation/parsing python module with definitions for the basic TCP/IP protocols.**
|
||||
|
||||
[](https://readthedocs.org/projects/dpkt)
|
||||
[](https://travis-ci.org/kbandla/dpkt)
|
||||
[](https://coveralls.io/r/kbandla/dpkt)
|
||||
[](https://landscape.io/github/kbandla/dpkt/master)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
[](https://travis-ci.org/kbandla/dpkt)
|
||||
[](https://coveralls.io/r/kbandla/dpkt)
|
||||
[](https://landscape.io/github/kbandla/dpkt/master)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
[](https://pypi.python.org/pypi/dpkt)
|
||||
|
||||
[](http://waffle.io/kbandla/dpkt)
|
||||
[](http://waffle.io/kbandla/dpkt)
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
|
@ -24,50 +23,17 @@ Installation
|
|||
Documentation
|
||||
-------------
|
||||
|
||||
<https://dpkt.readthedocs.org/>
|
||||
**[dpkt.readthedocs.org](https://dpkt.readthedocs.org/)**
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
To run the all tests run:
|
||||
|
||||
tox
|
||||
|
||||
### Deviations from upstream
|
||||
About
|
||||
-----
|
||||
|
||||
This code is based on [dpkt code](https://code.google.com/p/dpkt/) lead
|
||||
by Dug Song.
|
||||
by Dug Song and is now being maintained and improved by an extended set of [contributors](https://dpkt.readthedocs.org/en/latest/authors.html)
|
||||
and [developers](https://github.com/kbandla/dpkt/graphs/contributors).
|
||||
|
||||
At this point, this is not the exact [upstream
|
||||
version](https://code.google.com/p/dpkt/). If you are looking for the
|
||||
latest stock dpkt, please get it from the above link.
|
||||
|
||||
Almost all of the upstream changes are pulled. However, some modules are
|
||||
not. Here is a list of the changes:
|
||||
|
||||
- [dpkt/dpkt.py](https://github.com/kbandla/dpkt/commit/336fe02b0e2f00b382d91cd42558a69eec16d6c7):
|
||||
decouple dnet from dpkt
|
||||
- [dpkt/dns.py](https://github.com/kbandla/dpkt/commit/2bf3cde213144391fd90488d12f9ccce51b5fbca)
|
||||
: parse some more DNS flags
|
||||
|
||||
#### Examples
|
||||
|
||||
[@jonoberheide's](<https://twitter.com/jonoberheide>) old examples still
|
||||
apply:
|
||||
|
||||
- [dpkt Tutorial \#1: ICMP
|
||||
Echo](https://jon.oberheide.org/blog/2008/08/25/dpkt-tutorial-1-icmp-echo/)
|
||||
- [dpkt Tutorial \#2: Parsing a PCAP
|
||||
File](https://jon.oberheide.org/blog/2008/10/15/dpkt-tutorial-2-parsing-a-pcap-file/)
|
||||
- [dpkt Tutorial \#3: dns
|
||||
spoofing](https://jon.oberheide.org/blog/2008/12/20/dpkt-tutorial-3-dns-spoofing/)
|
||||
- [dpkt Tutorial \#4: AS Paths from
|
||||
MRT/BGP](https://jon.oberheide.org/blog/2009/03/25/dpkt-tutorial-4-as-paths-from-mrt-bgp/)
|
||||
|
||||
[Jeff Silverman](https://github.com/jeffsilverm) has some
|
||||
[code](https://github.com/jeffsilverm/dpkt_doc) and
|
||||
[documentation](http://www.commercialventvac.com/dpkt.html).
|
||||
|
||||
#### LICENSE
|
||||
|
||||
BSD 3-Clause License, as the upstream project
|
||||
BSD 3-Clause
|
||||
74
README.rst
74
README.rst
|
|
@ -3,42 +3,38 @@
|
|||
dpkt
|
||||
====
|
||||
|
||||
| |docs| |travis| |coveralls| |landscape| |version|
|
||||
| |downloads| |wheel| |supported-versions| |supported-implementations|
|
||||
| |travis| |coveralls| |landscape| |downloads|
|
||||
| |version| |wheel| |supported-versions| |supported-implementations|
|
||||
|
||||
.. |docs| image:: https://readthedocs.org/projects/dpkt/badge/?style=flat
|
||||
:target: https://readthedocs.org/projects/dpkt
|
||||
:alt: Documentation Status
|
||||
|
||||
.. |travis| image:: http://img.shields.io/travis/kbandla/dpkt/master.png?style=flat
|
||||
.. |travis| image:: http://img.shields.io/travis/kbandla/dpkt.svg
|
||||
:alt: Travis-CI Build Status
|
||||
:target: https://travis-ci.org/kbandla/dpkt
|
||||
|
||||
.. |coveralls| image:: http://img.shields.io/coveralls/kbandla/dpkt/master.png?style=flat
|
||||
.. |coveralls| image:: http://img.shields.io/coveralls/kbandla/dpkt.svg
|
||||
:alt: Coverage Status
|
||||
:target: https://coveralls.io/r/kbandla/dpkt
|
||||
|
||||
.. |landscape| image:: https://landscape.io/github/kbandla/dpkt/master/landscape.svg?style=flat
|
||||
.. |landscape| image:: https://landscape.io/github/kbandla/dpkt/master/landscape.svg
|
||||
:target: https://landscape.io/github/kbandla/dpkt/master
|
||||
:alt: Code Quality Status
|
||||
|
||||
.. |version| image:: http://img.shields.io/pypi/v/dpkt.png?style=flat
|
||||
.. |version| image:: http://img.shields.io/pypi/v/dpkt.svg
|
||||
:alt: PyPI Package latest release
|
||||
:target: https://pypi.python.org/pypi/dpkt
|
||||
|
||||
.. |downloads| image:: http://img.shields.io/pypi/dm/dpkt.png?style=flat
|
||||
.. |downloads| image:: http://img.shields.io/pypi/dm/dpkt.svg
|
||||
:alt: PyPI Package monthly downloads
|
||||
:target: https://pypi.python.org/pypi/dpkt
|
||||
|
||||
.. |wheel| image:: https://pypip.in/wheel/dpkt/badge.png?style=flat
|
||||
.. |wheel| image:: https://img.shields.io/pypi/wheel/dpkt.svg
|
||||
:alt: PyPI Wheel
|
||||
:target: https://pypi.python.org/pypi/dpkt
|
||||
|
||||
.. |supported-versions| image:: https://pypip.in/py_versions/dpkt/badge.png?style=flat
|
||||
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/dpkt.svg
|
||||
:alt: Supported versions
|
||||
:target: https://pypi.python.org/pypi/dpkt
|
||||
|
||||
.. |supported-implementations| image:: https://pypip.in/implementation/dpkt/badge.png?style=flat
|
||||
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/dpkt.svg
|
||||
:alt: Supported implementations
|
||||
:target: https://pypi.python.org/pypi/dpkt
|
||||
|
||||
|
|
@ -54,51 +50,15 @@ Documentation
|
|||
|
||||
https://dpkt.readthedocs.org/
|
||||
|
||||
Development
|
||||
===========
|
||||
About
|
||||
=====
|
||||
|
||||
To run the all tests run::
|
||||
|
||||
tox
|
||||
|
||||
|
||||
Deviations from upstream
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This code is based on `dpkt code <https://code.google.com/p/dpkt/>`__ lead by Dug Song.
|
||||
|
||||
At this point, this is not the exact `upstream
|
||||
version <https://code.google.com/p/dpkt/>`__. If you are looking for the
|
||||
latest stock dpkt, please get it from the above link.
|
||||
|
||||
Almost all of the upstream changes are pulled. However, some modules are
|
||||
not. Here is a list of the changes:
|
||||
|
||||
- `dpkt/dpkt.py <https://github.com/kbandla/dpkt/commit/336fe02b0e2f00b382d91cd42558a69eec16d6c7>`__:
|
||||
decouple dnet from dpkt
|
||||
- `dpkt/dns.py <https://github.com/kbandla/dpkt/commit/2bf3cde213144391fd90488d12f9ccce51b5fbca>`__
|
||||
: parse some more DNS flags
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
[@jonoberheide's](https://twitter.com/jonoberheide) old examples still
|
||||
apply:
|
||||
|
||||
- `dpkt Tutorial #1: ICMP
|
||||
Echo <https://jon.oberheide.org/blog/2008/08/25/dpkt-tutorial-1-icmp-echo/>`__
|
||||
- `dpkt Tutorial #2: Parsing a PCAP
|
||||
File <https://jon.oberheide.org/blog/2008/10/15/dpkt-tutorial-2-parsing-a-pcap-file/>`__
|
||||
- `dpkt Tutorial #3: dns
|
||||
spoofing <https://jon.oberheide.org/blog/2008/12/20/dpkt-tutorial-3-dns-spoofing/>`__
|
||||
- `dpkt Tutorial #4: AS Paths from
|
||||
MRT/BGP <https://jon.oberheide.org/blog/2009/03/25/dpkt-tutorial-4-as-paths-from-mrt-bgp/>`__
|
||||
|
||||
`Jeff Silverman <https://github.com/jeffsilverm>`__ has some
|
||||
`code <https://github.com/jeffsilverm/dpkt_doc>`__ and
|
||||
`documentation <http://www.commercialventvac.com/dpkt.html>`__.
|
||||
This code is based on `dpkt code <https://code.google.com/p/dpkt/>`__ lead by Dug Song and
|
||||
is now being maintained and improved by an extended set of
|
||||
`contributors <https://dpkt.readthedocs.org/en/latest/authors.html>`__
|
||||
and `developers <https://github.com/kbandla/dpkt/graphs/contributors>`__.
|
||||
|
||||
LICENSE
|
||||
-------
|
||||
|
||||
BSD 3-Clause License, as the upstream project
|
||||
BSD 3-Clause
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
"""fast, simple packet creation and parsing."""
|
||||
|
||||
__author__ = 'Dug Song <dugsong@monkey.org>'
|
||||
__copyright__ = 'Copyright (c) 2004 Dug Song'
|
||||
__author__ = 'Dug Song'
|
||||
__author_email__ = 'dugsong@monkey.org'
|
||||
__license__ = 'BSD'
|
||||
__url__ = 'http://dpkt.googlecode.com/'
|
||||
__version__ = '1.8.6'
|
||||
__version__ = '1.8.6.2'
|
||||
|
||||
from dpkt import *
|
||||
|
||||
|
|
@ -68,4 +68,4 @@ import tns
|
|||
import tpkt
|
||||
import udp
|
||||
import vrrp
|
||||
import yahoo
|
||||
import yahoo
|
||||
|
|
|
|||
Loading…
Reference in New Issue