vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-04 19:57:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: mkd -> rst

Browse source 
pypi only renders reStructuredText.
This commit is contained in:
Maximilian Hils 2015-11-29 19:04:19 +01:00
parent 4d17ddba38
commit 7cb57e206f
4 changed files with 38 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

4
MANIFEST.in
View file

@ -1,3 +1,3 @@
include LICENSE README.mkd
recursive-include test *
include LICENSE CONTRIBUTORS README.rst
graft test
recursive-exclude * *.pyc *.pyo *.swo *.swp

24
README.mkd
View file

@ -1,24 +0,0 @@
[![Build Status](https://img.shields.io/travis/mitmproxy/netlib/master.svg)](https://travis-ci.org/mitmproxy/netlib)
[![Code Health](https://landscape.io/github/mitmproxy/netlib/master/landscape.svg?style=flat)](https://landscape.io/github/mitmproxy/netlib/master)
[![Coverage Status](https://img.shields.io/coveralls/mitmproxy/netlib/master.svg)](https://coveralls.io/r/mitmproxy/netlib)
[![Downloads](https://img.shields.io/pypi/dm/netlib.svg?color=orange)](https://pypi.python.org/pypi/netlib)
[![Latest Version](https://img.shields.io/pypi/v/netlib.svg)](https://pypi.python.org/pypi/netlib)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/netlib.svg)](https://pypi.python.org/pypi/netlib)
Netlib is a collection of network utility classes, used by the pathod and
mitmproxy projects. It differs from other projects in some fundamental
respects, because both pathod and mitmproxy often need to violate standards.
This means that protocols are implemented as small, well-contained and flexible
functions, and are designed to allow misbehaviour when needed.
Requirements
------------
* [Python](http://www.python.org) 2.7.x or a compatible version of pypy.
* Third-party packages listed in [setup.py](https://github.com/mitmproxy/netlib/blob/master/setup.py)
Hacking
-------
If you'd like to work on netlib, check out the instructions in mitmproxy's [README](https://github.com/mitmproxy/mitmproxy#hacking).

35
README.rst Normal file
View file

@ -0,0 +1,35 @@
|travis| |coveralls| |downloads| |latest-release| |python-versions|
Netlib is a collection of network utility classes, used by the pathod and
mitmproxy projects. It differs from other projects in some fundamental
respects, because both pathod and mitmproxy often need to violate standards.
This means that protocols are implemented as small, well-contained and flexible
functions, and are designed to allow misbehaviour when needed.
Hacking
-------
If you'd like to work on netlib, check out the instructions in mitmproxy's README_.
.. |travis| image:: https://img.shields.io/travis/mitmproxy/netlib/master.svg
:target: https://travis-ci.org/mitmproxy/netlib
:alt: Build Status
.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/netlib/master.svg
:target: https://coveralls.io/r/mitmproxy/netlib
:alt: Coverage Status
.. |downloads| image:: https://img.shields.io/pypi/dm/netlib.svg?color=orange
:target: https://pypi.python.org/pypi/netlib
:alt: Downloads
.. |latest-release| image:: https://img.shields.io/pypi/v/netlib.svg
:target: https://pypi.python.org/pypi/netlib
:alt: Latest Version
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/netlib.svg
:target: https://pypi.python.org/pypi/netlib
:alt: Supported Python versions
.. _README: https://github.com/mitmproxy/mitmproxy#hacking

2
setup.py
View file

@ -11,7 +11,7 @@ from netlib import version
here = os.path.abspath(os.path.dirname(__file__))
with open(os.path.join(here, 'README.mkd'), encoding='utf-8') as f:
with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()
deps = {