Skip to content

Commit

Permalink
proper readme @ pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
Enteee committed Jul 15, 2016
1 parent 0a5815e commit 855a20a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
13 changes: 10 additions & 3 deletions README.md
Expand Up @@ -3,8 +3,8 @@ _Aggregates wireshark pdml to flows_

| Branch | Build | Coverage |
| ------- | ------ | -------- |
| master | [![Build Status](https://travis-ci.org/Enteee/pdml2flow.svg?branch=master)](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status](https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=master)](https://coveralls.io/github/Enteee/pdml2flow?branch=master) |
| develop | [![Build Status](https://travis-ci.org/Enteee/pdml2flow.svg?branch=develop)](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status](https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=develop)](https://coveralls.io/github/Enteee/pdml2flow?branch=develop) |
| master | [![Build Status master]](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status master]](https://coveralls.io/github/Enteee/pdml2flow?branch=master) |
| develop | [![Build Status develop]](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status develop]](https://coveralls.io/github/Enteee/pdml2flow?branch=develop) |

## Prerequisites
* [python]:
Expand All @@ -15,7 +15,9 @@ _Aggregates wireshark pdml to flows_
* [pip](https://pypi.python.org/pypi/pip)

## Installation
```shell
$ sudo pip install pdml2flow
```

## Usage
```shell
Expand Down Expand Up @@ -44,9 +46,9 @@ optional arguments:
-m Appends flow metadata [default: False]
-d Debug mode [default: False]
```
## Example
Sniff from interface:
```shell
$ tshark -i interface -Tpdml | pdml2flow
```
Expand Down Expand Up @@ -119,3 +121,8 @@ optional arguments:
[dict2xml]: https://github.com/delfick/python-dict2xml
[jq]: https://stedolan.github.io/jq/
[FluentFlow]: https://github.com/t-moe/FluentFlow
[Build Status master]: https://travis-ci.org/Enteee/pdml2flow.svg?branch=master
[Coverage Status master]: https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=master
[Build Status develop]: https://travis-ci.org/Enteee/pdml2flow.svg?branch=develop
[Coverage Status develop]: https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=develop
13 changes: 10 additions & 3 deletions scripts/mkreadme.sh
Expand Up @@ -10,8 +10,8 @@ _Aggregates wireshark pdml to flows_
| Branch | Build | Coverage |
| ------- | ------ | -------- |
| master | [![Build Status](https://travis-ci.org/Enteee/pdml2flow.svg?branch=master)](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status](https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=master)](https://coveralls.io/github/Enteee/pdml2flow?branch=master) |
| develop | [![Build Status](https://travis-ci.org/Enteee/pdml2flow.svg?branch=develop)](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status](https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=develop)](https://coveralls.io/github/Enteee/pdml2flow?branch=develop) |
| master | [![Build Status master]](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status master]](https://coveralls.io/github/Enteee/pdml2flow?branch=master) |
| develop | [![Build Status develop]](https://travis-ci.org/Enteee/pdml2flow) | [![Coverage Status develop]](https://coveralls.io/github/Enteee/pdml2flow?branch=develop) |
## Prerequisites
$( cat "${TOPLEVEL}/.travis.yml" |
Expand All @@ -24,16 +24,18 @@ $( cat "${TOPLEVEL}/.travis.yml" |
* [pip](https://pypi.python.org/pypi/pip)
## Installation
\`\`\`shell
$ sudo pip install pdml2flow
\`\`\`
## Usage
\`\`\`shell
$ pdml2flow -h
$(pdml2flow -h)
\`\`\`
## Example
Sniff from interface:
\`\`\`shell
$ tshark -i interface -Tpdml | pdml2flow
\`\`\`
Expand Down Expand Up @@ -90,4 +92,9 @@ $(pdml2xml -h)
[dict2xml]: https://github.com/delfick/python-dict2xml
[jq]: https://stedolan.github.io/jq/
[FluentFlow]: https://github.com/t-moe/FluentFlow
[Build Status master]: https://travis-ci.org/Enteee/pdml2flow.svg?branch=master
[Coverage Status master]: https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=master
[Build Status develop]: https://travis-ci.org/Enteee/pdml2flow.svg?branch=develop
[Coverage Status develop]: https://coveralls.io/repos/github/Enteee/pdml2flow/badge.svg?branch=develop
EOF
6 changes: 3 additions & 3 deletions setup.py
Expand Up @@ -4,8 +4,8 @@
# from: https://coderwall.com/p/qawuyq/use-markdown-readme-s-in-python-modules
try:
import pypandoc
long_description = pypandoc.convert('README.md', 'rst', 'md')
long_description = long_description.replace('\r','')
long_description = pypandoc.convert('README.md', 'rst', format='markdown_github')
#long_description = long_description.replace("\r","")
with open('README.rst', 'w') as f:
f.write(long_description)
except (OSError, ImportError):
Expand All @@ -18,7 +18,7 @@
setup(
name = 'pdml2flow',
keywords = 'wireshark pdml flow aggregation',
version = '1.5',
version = '2.0',
packages = find_packages(),
install_requires = [
'dict2xml'
Expand Down

0 comments on commit 855a20a

Please sign in to comment.