Commit 12681840 authored by Jim Fulton's avatar Jim Fulton

PyPI improvements

parent 6d673057
For developers of ZODB
======================
Building
---------
Bootstrap buildout, if necessary using ``bootstrap.py``::
python bootstrap.py
Run the buildout::
bin/buildout
Testing
-------
The ZODB checkouts are `buildouts <http://www.python.org/pypi/zc.buildout>`_.
When working from a ZODB checkout, first run the bootstrap.py script
to initialize the buildout:
% python bootstrap.py
and then use the buildout script to build ZODB and gather the dependencies:
% bin/buildout
This creates a test script:
% bin/test -v
This command will run all the tests, printing a single dot for each
test. When it finishes, it will print a test summary. The exact
number of tests can vary depending on platform and available
third-party libraries.::
Ran 1182 tests in 241.269s
OK
The test script has many more options. Use the ``-h`` or ``--help``
options to see a file list of options. The default test suite omits
several tests that depend on third-party software or that take a long
time to run. To run all the available tests use the ``--all`` option.
Running all the tests takes much longer.::
Ran 1561 tests in 1461.557s
OK
Our primary development platforms are Linux and Mac OS X. The test
suite should pass without error on these platforms and, hopefully,
Windows, although it can take a long time on Windows -- longer if you
use ZoneAlarm.
Generating docs
---------------
cd to the doc directory and::
make html
Contributing
------------
Almost any code change should include tests.
Any change that changes features should include documentation updates.
...@@ -2,112 +2,20 @@ ...@@ -2,112 +2,20 @@
ZODB ZODB
==== ====
Introduction ZODB provides an object-oriented database for Python that provides a
============ high-degree of transparency.
The ZODB package provides a set of tools for using the Zope Object - no separate language for database operations
Database (ZODB).
Our primary development platforms are Linux and Mac OS X. The test - very little impact on your code to make objects persistent
suite should pass without error on these platforms and, hopefully,
Windows, although it can take a long time on Windows -- longer if you
use ZoneAlarm.
Compatibility - no database mapper that partially hides the database.
=============
ZODB 5 requires Python 2.7 (>= 2.7.9) or Python >= 3.3. Using an object-relational mapping **is not** like using an
object-oriented database.
Documentation - almost no seam between code and database.
=============
See http://zodb-docs.readthedocs.io/en/latest/ ZODB is an ACID Transactional database.
For developers of ZODB To learn more, visit: http://www.zodb.org
======================
Building
---------
Bootstrap buildout, if necessary using ``bootstrap.py``::
python bootstrap.py
Run the buildout::
bin/buildout
Testing
-------
The ZODB checkouts are `buildouts <http://www.python.org/pypi/zc.buildout>`_.
When working from a ZODB checkout, first run the bootstrap.py script
to initialize the buildout:
% python bootstrap.py
and then use the buildout script to build ZODB and gather the dependencies:
% bin/buildout
This creates a test script:
% bin/test -v
This command will run all the tests, printing a single dot for each
test. When it finishes, it will print a test summary. The exact
number of tests can vary depending on platform and available
third-party libraries.::
Ran 1182 tests in 241.269s
OK
The test script has many more options. Use the ``-h`` or ``--help``
options to see a file list of options. The default test suite omits
several tests that depend on third-party software or that take a long
time to run. To run all the available tests use the ``--all`` option.
Running all the tests takes much longer.::
Ran 1561 tests in 1461.557s
OK
Generating docs
---------------
cd to the doc directory and::
make html
Contributing
------------
Almost any code change should include tests.
Any change that changes features should include documentation updates.
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.
License
=======
ZODB is distributed under the Zope Public License, an OSI-approved
open source license. Please see the LICENSE.txt file for terms and
conditions.
More information
================
See http://zodb.org/
.. image:: https://badges.gitter.im/zopefoundation/ZODB.svg
:alt: Join the chat at https://gitter.im/zopefoundation/ZODB
:target: https://gitter.im/zopefoundation/ZODB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
...@@ -11,15 +11,6 @@ ...@@ -11,15 +11,6 @@
# FOR A PARTICULAR PURPOSE. # FOR A PARTICULAR PURPOSE.
# #
############################################################################## ##############################################################################
"""Zope Object Database: object database and persistence
The Zope Object Database provides an object-oriented database for
Python that provides a high-degree of transparency. Applications can
take advantage of object database features with few, if any, changes
to application logic. ZODB includes features such as a plugable storage
interface, rich transaction support, and undo.
"""
version = '5.2.1.dev0' version = '5.2.1.dev0'
import os import os
...@@ -100,19 +91,11 @@ def alltests(): ...@@ -100,19 +91,11 @@ def alltests():
_unittests_only(suite, mod.test_suite()) _unittests_only(suite, mod.test_suite())
return suite return suite
doclines = __doc__.split("\n") long_description = (
open("README.rst").read() +
def read_file(*path): "\n\n" +
base_dir = os.path.dirname(__file__) open("CHANGES.rst").read()
file_path = (base_dir, ) + tuple(path) )
with open(os.path.join(*file_path), 'rb') as file:
return file.read()
long_description = str(
("\n".join(doclines[2:]) + "\n\n" +
".. contents::\n\n" +
read_file("README.rst").decode('latin-1') + "\n\n" +
read_file("CHANGES.rst").decode('latin-1')))
tests_require = ['zope.testing', 'manuel'] tests_require = ['zope.testing', 'manuel']
...@@ -128,7 +111,7 @@ setup(name="ZODB", ...@@ -128,7 +111,7 @@ setup(name="ZODB",
url = 'http://www.zodb.org/', url = 'http://www.zodb.org/',
license = "ZPL 2.1", license = "ZPL 2.1",
platforms = ["any"], platforms = ["any"],
description = doclines[0], description = long_description[1],
classifiers = list(filter(None, classifiers.split("\n"))), classifiers = list(filter(None, classifiers.split("\n"))),
long_description = long_description, long_description = long_description,
test_suite="__main__.alltests", # to support "setup.py test" test_suite="__main__.alltests", # to support "setup.py test"
......
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