Merge pull request cemerick#8 from maxcountryman/documentation

Add metadata and docstrings to the modules themselves, derive version in setup.py from there

Author: cemerick

nrepl/__init__.py

@@ -1,5 +1,16 @@
 #!/usr/bin/env python
 
+'''
+    nrepl
+    -----
+
+    A Python client for the nREPL Clojure networked-REPL server.
+
+    :copyright: (c) 2013 by Chas Emerick.
+    :license: MIT, see LICENSE for more details.
+'''
+
+
 import socket
 import nrepl.bencode as bencode
 import threading
@@ -8,6 +19,13 @@
 except ImportError:
     from urllib.parse import urlparse, ParseResult
 
+__version_info__ = ('0', '0', '3')
+__version__ = '.'.join(__version_info__)
+__author__ = 'Chas Emerick'
+__license__ = 'MIT'
+__copyright__ = '(c) 2013 by Chas Emerick'
+__all__ = ['connect', 'WatchableConnection']
+
 
 def _bencode_connect(uri):
     s = socket.create_connection(uri.netloc.split(":"))

nrepl/bencode.py

@@ -1,5 +1,16 @@
 #!/usr/bin/env python
 
+'''
+    nrepl.bencode
+    -------------
+
+    This module provides BEncode-protocol support.
+
+    :copyright: (c) 2013 by Chas Emerick.
+    :license: MIT, see LICENSE for more details.
+'''
+
+
 try:
     from cStringIO import StringIO
 except ImportError:

setup.py

@@ -9,8 +9,18 @@
     * `development version <https://github.com/cemerick/nrepl-python-client>`_
 '''
 
+import os
+
 from setuptools import setup, find_packages
 
+# HACK: Pull the version number without requiring the package to be installed
+# beforehand, i.e. without using import.
+module_path = os.path.join(os.path.dirname(__file__), 'nrepl/__init__.py')
+version_line = [line for line in open(module_path)
+                if line.startswith('__version_info__')][0]
+
+__version__ = '.'.join(eval(version_line.split('__version_info__ = ')[-1]))
+
 description = "A Python client for the nREPL Clojure networked-REPL server."
 classifiers = ['Development Status :: 4 - Beta',
                'Environment :: Console',
@@ -24,7 +34,7 @@
                'Topic :: Utilities']
 
 setup(name="nrepl-python-client",
-      version="0.0.3",
+      version=__version__,
       packages=find_packages(),
       # metadata for upload to PyPI
       author="Chas Emerick",