Commits

Jan-Philip Gehrcke committed 092c795

Modify docs, setup.py and README.

Comments (0)

Files changed (2)

-With ``gipc`` you can easily use ``multiprocessing`` and ``gevent`` within one Python application.
+What can gipc do for you?
+=========================
+With ``gipc`` you can easily use ``multiprocessing`` and ``gevent`` within one Python application. It provides gevent-aware `multiprocessing.Process``-based child processes and gevent-cooperative inter-process communication.
 
-**What does gipc provide?**
 
-    - gevent-aware ``multiprocessing.Process``-based child processes.
-    - gevent-aware inter-process communication (a lot of dashes, huh?).
-
-
-**Isn't this achievable with just gevent+multiprocessing?**
-
-It is, and this is precisely what ``gipc`` does. It just requires at lot of care:
+Isn't this achievable with just gevent+multiprocessing?
+=======================================================
+It is, and this is precisely what ``gipc`` does. It just requires some care:
 On Unix, child process creation via Python's ``multiprocessing`` package in the
 context of ``gevent`` might yield an undesired event loop state in the child and
 most likely breaks your application in some way. Furthermore, blocking method calls
 simple integration of child processes in your application.
 
 
-Docs:
-The documentation with API details, installation instructions and requirements can be found online at http://gehrcke.de/gipc.
+Documentation
+=============
+The documentation with API details, detailed installation instructions and requirements can be found online at http://gehrcke.de/gipc.
 
-Availability:
-Download the latest release at PyPI (http://pypi.python.org/pypi/gipc) or clone the repository from bitbucket (https://bitbucket.org/jgehrcke/gipc).
 
+Availability
+============
+Download the latest release at `PyPI <http://pypi.python.org/pypi/gipc>`_  or download/clone the development version from the mercurial repository at `bitbucket <https://bitbucket.org/jgehrcke/gipc>`_.
 
-License:
-gipc is written and maintained by Jan-Philip Gehrcke (http://gehrcke.de) and is licensed under the Apache 2 license.
 
-Contact:
-I would appreciate your feedback. You can contact me at jgehrcke@googlemail.com
+Author & license
+================
+``gipc`` is written and maintained by `Jan-Philip Gehrcke <http://gehrcke.de>`_ and is licensed under the `Apache License 2.0 <http://www.apache.org/licenses/LICENSE-2.0.txt>`_.
+
+
+Contact
+=======
+Your feedback is highly appreciated. You can contact me at jgehrcke@googlemail.com.
     name = "gipc",
     packages = ["gipc"],
     version = "0.1.0",
-    description = "Multiprocessing and IPC for gevent",
+    description = "gevent-cooperative multiprocessing and inter-process communication.",
     long_description=open("README").read().decode('utf-8'),
     author = "Jan-Philip Gehrcke",
     author_email = "jgehrcke@googlemail.com",
     url = "http://gehrcke.de/gipc",
     download_url = "http://gehrcke.de/gipc",
     keywords = ["gevent", "ipc", "multiprocessing"],
+    license = "Apache License 2.0",
     classifiers = [
         "Programming Language :: Python",
         "Development Status :: 3 - Alpha",