[Checkins] SVN: zc.ngi/branches/jim-dev/ Redid pypi docs.

Jim Fulton jim at zope.com
Thu Oct 1 07:07:50 EDT 2009


Log message for revision 104675:
  Redid pypi docs.
  

Changed:
  U   zc.ngi/branches/jim-dev/README.txt
  U   zc.ngi/branches/jim-dev/setup.py

-=-
Modified: zc.ngi/branches/jim-dev/README.txt
===================================================================
--- zc.ngi/branches/jim-dev/README.txt	2009-10-01 11:07:47 UTC (rev 104674)
+++ zc.ngi/branches/jim-dev/README.txt	2009-10-01 11:07:49 UTC (rev 104675)
@@ -1,18 +1,21 @@
-*************************
 Network Gateway Interface
 *************************
 
-Network programs are typically difficult to test because they require
-setting up network connections, clients, and servers.  In addition,
-application code gets mixed up with networking code.
+The Network Gateway Interface provides:
 
-The Network Gateway Interface (NGI) seeks to improve this situation by
-separating application code from network code.  This allows
-application and network code to be tested independently and provides
-greater separation of concerns.
+- the ability to test application networking code without use of
+  sockets, threads or subprocesses
 
-.. contents::
+- clean separation of application code and low-level networking code
 
+- a fairly simple inheritence free set of networking APIs
+
+- an event-based framework that makes it easy to handle many
+  simultaneous connections while still supporting an imperative
+  programming style.
+
+To learn more, see http://packages.python.org/zc.ngi/
+
 Changes
 *******
 

Modified: zc.ngi/branches/jim-dev/setup.py
===================================================================
--- zc.ngi/branches/jim-dev/setup.py	2009-10-01 11:07:47 UTC (rev 104674)
+++ zc.ngi/branches/jim-dev/setup.py	2009-10-01 11:07:49 UTC (rev 104675)
@@ -14,39 +14,19 @@
 
 name, version = 'zc.ngi', '0'
 
-import os
 from setuptools import setup, find_packages
 
-def read(*rnames):
-    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+readme = open('README.txt').read()
 
-long_description=(
-        read('README.txt')
-        + '\n' +
-        'Detailed Documentation\n'
-        '**********************\n'
-        + '\n' +
-        read('src', 'zc', 'ngi', 'README.txt')
-        + '\n' +
-        read('src', 'zc', 'ngi', 'blocking.txt')
-        + '\n' +
-        read('src', 'zc', 'ngi', 'adapters.txt')
-        + '\n' +
-        read('src', 'zc', 'ngi', 'async.txt')
-        + '\n' +
-        'Download\n'
-        '**********************\n'
-        )
-
 setup(
     name = name, version=version,
     author = "Jim Fulton",
     author_email = "jim at zope.com",
-    description = "Network Gateway Interface",
+    description = readme.split('\n', 1)[0],
     license = "ZPL 2.1",
-    keywords = "network",
-    url='http://www.python.org/pypi/'+name,
-    long_description=long_description,
+    keywords = ["networking", "testing"],
+    url='http://packages.python.org/'+name,
+    long_description=readme,
 
     packages = find_packages('src'),
     include_package_data = True,



More information about the checkins mailing list