Commit d114a74c authored by Christophe Combelles's avatar Christophe Combelles

Added the README.txt and NEWS.txt to the long_description

parent 6714794f
ZODB 3.8 ZODB 3.8
======== ========
.. contents::
Introduction Introduction
------------ ------------
...@@ -11,8 +15,8 @@ follows: ...@@ -11,8 +15,8 @@ follows:
- Core ZODB, including the persistence machinery - Core ZODB, including the persistence machinery
- Standard storages such as FileStorage - Standard storages such as FileStorage
- The persistent BTrees modules - The persistent BTrees modules
- ZEO - ZEO, for scalability needs
- documentation (poor) - documentation (needs more work)
Our primary development platforms are Linux, Mac OS X, and Windows Our primary development platforms are Linux, Mac OS X, and Windows
XP. The test suite should pass without error on all of these XP. The test suite should pass without error on all of these
...@@ -81,7 +85,7 @@ This should now make all of ZODB accessible to your Python programs. ...@@ -81,7 +85,7 @@ This should now make all of ZODB accessible to your Python programs.
Testing for Developers Testing for Developers
---------------------- ----------------------
The ZODB check outs are `buldouts <http://www.python.org/pypi/zc.buildout>`_. The ZODB checkouts are `buildouts <http://www.python.org/pypi/zc.buildout>`_.
When working from a ZODB checkout, first run the bootstrap.py script When working from a ZODB checkout, first run the bootstrap.py script
to initialize the buildout: to initialize the buildout:
...@@ -115,6 +119,15 @@ Running all the tests takes much longer.:: ...@@ -115,6 +119,15 @@ Running all the tests takes much longer.::
OK OK
Maintenance scripts
-------------------
Several scripts are provided with the ZODB and can help for analyzing,
debugging, checking for consistency, summarizing content, reporting space used
by objects, doing backups, artificial load testing, etc.
Look at the ZODB/script directory for more informations.
History History
------- -------
...@@ -148,9 +161,7 @@ Why not call the current release StandaloneZODB? The name ...@@ -148,9 +161,7 @@ Why not call the current release StandaloneZODB? The name
StandaloneZODB is a bit of a mouthful. The standalone part of the StandaloneZODB is a bit of a mouthful. The standalone part of the
name suggests that the Zope version is the real version and that this name suggests that the Zope version is the real version and that this
is an afterthought, which isn't the case. So we're calling this is an afterthought, which isn't the case. So we're calling this
release "ZODB". release "ZODB". We also worked on a ZODB4 package for a while and
To make matters worse, we worked on a ZODB4 package for a while and
made a couple of alpha releases. We've now abandoned that effort, made a couple of alpha releases. We've now abandoned that effort,
because we didn't have the resources to pursue ot while also maintaining because we didn't have the resources to pursue ot while also maintaining
ZODB(3). ZODB(3).
...@@ -201,10 +212,9 @@ browser at the file Doc/guide/zodb/index.html ...@@ -201,10 +212,9 @@ browser at the file Doc/guide/zodb/index.html
Bugs and Patches Bugs and Patches
---------------- ----------------
Bug reports and patches should be added to the Zope Collector, with Bug reports and patches should be added to the Launchpad:
topic "Database":
http://collector.zope.org/Zope https://launchpad.net/zodb
.. ..
......
...@@ -245,7 +245,8 @@ class MyDistribution(Distribution): ...@@ -245,7 +245,8 @@ class MyDistribution(Distribution):
self.cmdclass['build_py'] = MyPyBuilder self.cmdclass['build_py'] = MyPyBuilder
self.cmdclass['install_lib'] = MyLibInstaller self.cmdclass['install_lib'] = MyLibInstaller
doclines = __doc__.split("\n") def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
setup(name="ZODB3", setup(name="ZODB3",
...@@ -260,8 +261,13 @@ setup(name="ZODB3", ...@@ -260,8 +261,13 @@ setup(name="ZODB3",
'src/persistent/ring.h'], 'src/persistent/ring.h'],
license = "ZPL 2.1", license = "ZPL 2.1",
platforms = ["any"], platforms = ["any"],
description = doclines[0], description = __doc__.split("\n")[0],
classifiers = filter(None, classifiers.split("\n")), classifiers = filter(None, classifiers.split("\n")),
long_description = "\n".join(doclines[2:]), long_description = (
__doc__
+ read('README.txt')
+ '\n\n'
+ read('NEWS.txt')
),
distclass = MyDistribution, distclass = MyDistribution,
**extra) **extra)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment