Skip to content

Commit 31b1b0b

Browse files
committed
Write README
1 parent 2c0e9f4 commit 31b1b0b

File tree

3 files changed

+34
-5
lines changed

3 files changed

+34
-5
lines changed

README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Bencoder.pyx
2+
============
3+
4+
A fast bencode implementation in Cython supports both Python2 & Python3 .
5+
6+
.. image:: https://travis-ci.org/whtsky/bencoder.pyx.svg?branch=master
7+
:target: https://travis-ci.org/whtsky/bencoder.pyx
8+
9+
Install
10+
-------
11+
12+
13+
.. code-block:: bash
14+
15+
pip install bencoder.pyx
16+
17+
18+
Usage
19+
-----
20+
21+
22+
.. code-block:: python
23+
24+
from bencoder import bencode, bdecode
25+
26+
assert bencode("WWWWWW") == b'6:WWWWWW'
27+
assert bencode(233) == b'i233e'
28+
29+
with open("debian-8.3.0-amd64-netinst.iso.torrent", "rb") as f:
30+
torrent = bdecode(f.read())
31+
print(torrent['announce'])

setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@
1515

1616
setup(
1717
name='bencoder.pyx',
18-
version='1.0',
18+
version='1.0.0',
1919
description='Yet another bencode implementation in Cython',
20-
long_description="""""",
20+
long_description=open("README.rst", "r").read(),
2121
author='whtsky',
2222
author_email='whtsky@gmail.com',
2323
url='https://github.com/whtsky/bencoder.pyx',
2424
license="BSDv3",
2525
platforms=['POSIX', 'Windows'],
26-
keywords=['bencoding', 'encode', 'decode', 'bittorrent'],
26+
keywords=['bencoding', 'encode', 'decode', 'bittorrent', 'bencode', 'bencoder', 'cython'],
2727
classifiers=[
2828
"Environment :: Other Environment",
2929
"Intended Audience :: Developers",

0 commit comments

Comments
 (0)