move doctests to README.rst

Author: graingert

README.rst

@@ -1,26 +1,53 @@
-clamd
-=====
-
-.. image:: https://travis-ci.org/graingert/python-clamd.png?branch=master
-   :alt: travis build status
-   :target: https://travis-ci.org/graingert/python-clamd
-
-About
------
-`clamd` is a portable Python module to use the ClamAV anti-virus engine on 
-Windows, Linux, MacOSX and other platforms. It requires a running instance of 
-the `clamd` daemon.
-
-This is a fork of pyClamd v0.2.0 created by Philippe Lagadec and published on his website: http://www.decalage.info/en/python/pyclamd which in turn is a slightly improved version of pyClamd v0.1.1 created by Alexandre Norman and published on his website: http://xael.org/norman/python/pyclamd/
-
-License
--------
-`clamd` is released as open-source software under the LGPL license.
-
-clamd Install
--------------
-How to install the ClamAV daemon `clamd` under Ubuntu::
-
-    sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
-    sudo freshclam
-    sudo service clamav-daemon start
+clamd
+=====
+
+.. image:: https://travis-ci.org/graingert/python-clamd.png?branch=master
+   :alt: travis build status
+   :target: https://travis-ci.org/graingert/python-clamd
+
+About
+-----
+`clamd` is a portable Python module to use the ClamAV anti-virus engine on 
+Windows, Linux, MacOSX and other platforms. It requires a running instance of 
+the `clamd` daemon.
+
+This is a fork of pyClamd v0.2.0 created by Philippe Lagadec and published on his website: http://www.decalage.info/en/python/pyclamd which in turn is a slightly improved version of pyClamd v0.1.1 created by Alexandre Norman and published on his website: http://xael.org/norman/python/pyclamd/
+
+Usage
+-----
+
+To use with a unix socket::
+
+    >>> import clamd
+    >>> cd = clamd.ClamdUnixSocket()
+    >>> cd.ping()
+    u'PONG'
+    >>> cd.version()                             # doctest: +ELLIPSIS
+    u'ClamAV ...
+    >>> cd.reload()
+    u'RELOADING'
+
+To scan a file::
+
+    >>> open('/tmp/EICAR','wb').write(clamd.EICAR)
+    >>> cd.scan('/tmp/EICAR')
+    {u'/tmp/EICAR': (u'FOUND', u'Eicar-Test-Signature')}
+
+To scan a stream::
+
+    >>> from six import BytesIO
+    >>> cd.instream(BytesIO(clamd.EICAR))
+    {u'stream': (u'FOUND', u'Eicar-Test-Signature')}
+
+
+License
+-------
+`clamd` is released as open-source software under the LGPL license.
+
+clamd Install
+-------------
+How to install the ClamAV daemon `clamd` under Ubuntu::
+
+    sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
+    sudo freshclam
+    sudo service clamav-daemon start

clamd.py

@@ -1,36 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
-"""
-clamd.py
-
-Author : Alexandre Norman - norman()xael.org
-Contributors :
-  Philippe Lagadec - philippe.lagadec()laposte.net
-  Thomas Kastner - tk()underground8.com
-Licence : LGPL
-
-Usage :
-
-Test strings :
-^^^^^^^^^^^^
-
->>> import clamd
->>> from six import BytesIO
->>> cd = clamd.ClamdUnixSocket()
->>> cd.ping()
-True
->>> cd.version().split()[0]
-'ClamAV'
->>> cd.reload()
-'RELOADING'
->>> open('/tmp/EICAR','wb').write(clamd.EICAR)
->>> cd.scan('/tmp/EICAR')
-{'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')}
->>> cd.instream(BytesIO(clamd.EICAR))
-{'stream': ('FOUND', 'Eicar-Test-Signature')}
-
-"""
 
 try:
     __version__ = __import__('pkg_resources').get_distribution('clamd').version

setup.cfg

@@ -28,3 +28,4 @@ tests-require = six
 
 [nosetests]
 with-doctest=1
+doctest-extension=rst