Skip to content

Commit 4d2a32b

Browse files
committed
Replaced [README.txt] with [README.rst]
1 parent 3e7f49e commit 4d2a32b

File tree

2 files changed

+59
-7
lines changed

2 files changed

+59
-7
lines changed

README.rst

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
bencode.py
2+
==========
3+
4+
.. image:: https://img.shields.io/pypi/v/bencode.py.svg?style=flat-square
5+
:target: https://pypi.python.org/pypi/bencode.py
6+
7+
.. image:: https://img.shields.io/travis/fuzeman/bencode.py.svg?style=flat-square
8+
:target: https://travis-ci.org/fuzeman/bencode.py
9+
10+
.. image:: https://img.shields.io/coveralls/fuzeman/bencode.py/master.svg?style=flat-square
11+
:target: https://coveralls.io/github/fuzeman/bencode.py
12+
13+
BitTorrent bencode module with Python 3+ compatibility, forked from the bencode__ package by Thomas Rampelberg.
14+
15+
__ https://pypi.python.org/pypi/bencode
16+
17+
18+
Usage
19+
-----
20+
21+
**Encode:**
22+
23+
.. code-block:: python
24+
25+
import bencode
26+
27+
bencode.encode({'title': 'Example'})
28+
# 'd5:title7:Examplee'
29+
30+
bencode.encode(12)
31+
# 'i12e'
32+
33+
**Decode:**
34+
35+
.. code-block:: python
36+
37+
import bencode
38+
39+
bencode.decode('d5:title7:Examplee')
40+
# {'title': 'Example'}
41+
42+
bencode.decode('i12e')
43+
# 12
44+
45+
46+
API
47+
---
48+
49+
``bencode.bencode(value)``
50+
51+
``bencode.encode(value)``
52+
53+
Encode ``value`` into the bencode format.
54+
55+
``bencode.bdecode(value)``
56+
57+
``bencode.decode(value)``
58+
59+
Decode bencode formatted string ``value``

README.txt

-7
This file was deleted.

0 commit comments

Comments
 (0)