improve the packaging

Author: SkypLabs

MANIFEST.in

@@ -1 +1,2 @@
-include README.md
+include README.rst
+include LICENSE

README.md

@@ -0,0 +1,86 @@
+======================
+Python HDLC controller
+======================
+
+|Build Status|
+
+HDLC controller written in Python and based on the
+`python4yahdlc <https://github.com/SkypLabs/python4yahdlc>`__ Python
+module to encode and decode HDLC frames.
+
+Installation
+============
+
+With pip (recommanded)
+----------------------
+
+::
+
+    pip3 install hdlcontroller
+
+From sources
+------------
+
+::
+
+    git clone https://github.com/SkypLabs/python-hdlc-controller.git
+    cd python-hdlc-controller
+    python3 setup.py install
+
+Usage
+=====
+
+To create a new HDLC controller instance, you need to call the
+*HDLController* class with two parameters :
+
+::
+
+    hdlc_c = HDLController(read_func, write_func)
+
+The first parameter is a function used to read from the serial bus while
+the second parameter is a function to write on it. For example, using
+the *pyserial* module :
+
+::
+
+    ser = serial.Serial('/dev/ttyACM0')
+
+    def read_serial():
+        return ser.read(ser.inWaiting())
+
+    hdlc_c = HDLController(read_serial, ser.write)
+
+To start the reception thread :
+
+::
+
+    hdlc_c.start()
+
+To send a new data frame :
+
+::
+
+    hdlc_c.send('Hello world!')
+
+And to get the next data frame received available in the *HDLController*
+internal queue :
+
+::
+
+    data = hdlc_c.get_data()
+
+The *get\_data()* method will block until a new data frame is available.
+
+Finally, to stop all the *HDLController* threads :
+
+::
+
+    hdlc_c.stop()
+
+License
+=======
+
+`MIT <http://opensource.org/licenses/MIT>`__
+
+.. |Build Status| image:: https://travis-ci.org/SkypLabs/python-hdlc-controller.svg
+   :target: https://travis-ci.org/SkypLabs/python-hdlc-controller

README.rst

@@ -1,23 +1,39 @@
 #!/usr/bin/env python3
 
 from setuptools import setup
+from os.path import dirname, abspath, join
+from codecs import open
 
-VERSION = '0.3.0'
+DIR = dirname(abspath(__file__))
+VERSION = '0.3.1'
+
+with open(join(DIR, 'README.rst'), encoding='utf-8') as f:
+    long_description = f.read()
 
 setup(
-	name = 'hdlcontroller',
-	version = VERSION,
-	description = 'HDLC controller',
-	license = 'MIT',
-	keywords = 'hdlc',
-	author = 'Paul-Emmanuel Raoul',
-	author_email = 'skyper@skyplabs.net',
-	url = 'https://github.com/SkypLabs/python-hdlc-controller',
-	download_url = 'https://github.com/SkypLabs/python-hdlc-controller/archive/v{0}.zip'.format(VERSION),
-	setup_requires = ['setuptools-markdown'],
-	long_description_markdown_filename = 'README.md',
-	py_modules = ['hdlcontroller'],
-	scripts = ['hdlcontroller.py'],
-	install_requires = ['python4yahdlc>=1.0.2', 'pyserial'],
-	test_suite = 'test',
+    name = 'hdlcontroller',
+    version = VERSION,
+    description = 'HDLC controller',
+    long_description = long_description,
+    license = 'MIT',
+    keywords = 'hdlc controller',
+    author = 'Paul-Emmanuel Raoul',
+    author_email = 'skyper@skyplabs.net',
+    url = 'https://github.com/SkypLabs/python-hdlc-controller',
+    download_url = 'https://github.com/SkypLabs/python-hdlc-controller/archive/v{0}.zip'.format(VERSION),
+    classifiers = [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.2',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'License :: OSI Approved :: MIT License',
+    ],
+    py_modules = ['hdlcontroller'],
+    scripts = ['hdlcontroller.py'],
+    install_requires = ['python4yahdlc>=1.0.2', 'pyserial'],
+    test_suite = 'test',
 )