package ready for pypi

Author: miccoli

MANIFEST.in

@@ -1 +1 @@
-include README.md
+include README.txt

Makefile

@@ -0,0 +1,5 @@
+#
+# mantain both markdown and reStructuredText README
+#
+README.txt: README.md
+	pandoc --from=markdown --to=rst --output=$@ --reference-links $?

README.md

@@ -6,6 +6,7 @@ pyownet is a pure python package that allows to access an
 in short _ownet_.
 
 owserver is part of the [OWFS 1-Wire File System](http://owfs.org):
+
 > OWFS is an easy way to use the powerful 1-wire system of Dallas/Maxim.
 >
 > OWFS is a simple and flexible program to monitor and control the physical

README.txt

@@ -0,0 +1,34 @@
+pyownet, a pythonic interface to ownet
+======================================
+
+pyownet is a pure python package that allows to access an `owserver`_
+via the `owserver network protocol`_, in short *ownet*.
+
+owserver is part of the `OWFS 1-Wire File System`_:
+
+    OWFS is an easy way to use the powerful 1-wire system of
+    Dallas/Maxim.
+
+    OWFS is a simple and flexible program to monitor and control the
+    physical environment. You can write scripts to read temperature,
+    flash lights, write to an LCD, log and graph, ...
+
+The ``pyownet.protocol`` module is a low-level implementation of the
+ownet protocol. Interaction with an owserver takes place via a proxy
+object whose methods correspond to ownet messages:
+
+::
+
+    >>> owproxy = OwnetProxy(host="owserver.example.com", port=4304)
+    >>> owproxy.ping()
+    >>> owproxy.dir()
+    ['/10.67C6697351FF/', '/05.4AEC29CDBAAB/']
+    >>> owproxy.present('/10.67C6697351FF/temperature')
+    True
+    >>> owproxy.read('/10.67C6697351FF/temperature')
+    '     91.6195'
+
+
+.. _owserver: http://owfs.org/index.php?page=owserver_protocol
+.. _owserver network protocol: http://owfs.org/index.php?page=owserver-protocol
+.. _OWFS 1-Wire File System: http://owfs.org

pyownet/__init__.py

@@ -17,4 +17,4 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-__version__ = '0.7.0.dev0'
+__version__ = '0.7.0.dev1'

setup.py

@@ -1,5 +1,8 @@
 from pyownet import __version__
 
+with open('README.txt') as file:
+    long_description = file.read()
+
 from distutils.core import setup
 try:
     from distutils.command.build_py import build_py_2to3 as build_py
@@ -11,6 +14,7 @@
       version = __version__,
       packages = ['pyownet', ],
       description = 'python ownet client library',
+      long_description = long_description,
       author = 'Stefano Miccoli',
       author_email = 'stefano.miccoli@polimi.it',
       url = 'https://github.com/miccoli/pyownet',
@@ -20,5 +24,5 @@
           'Intended Audience :: Developers',
           'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
           ],
-      cmdclass = {'build_py':build_py}
+      cmdclass = {'build_py':build_py},
      )