setup.py 9.67 KB
Newer Older
1
##############################################################################
2
#
3
# Copyright (c) 2002, 2003 Zope Corporation and Contributors.
4 5 6
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
Jim Fulton's avatar
Jim Fulton committed
7
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
8 9 10 11 12 13
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
14 15 16 17 18 19 20 21 22
"""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.
"""

Jim Fulton's avatar
Jim Fulton committed
23
VERSION = "3.9.0b1"
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
# The (non-obvious!) choices for the Trove Development Status line:
# Development Status :: 5 - Production/Stable
# Development Status :: 4 - Beta
# Development Status :: 3 - Alpha

classifiers = """\
Development Status :: 3 - Alpha
Intended Audience :: Developers
License :: OSI Approved :: Zope Public License
Programming Language :: Python
Topic :: Database
Topic :: Software Development :: Libraries :: Python Modules
Operating System :: Microsoft :: Windows
Operating System :: Unix
"""
40

41 42 43
from setuptools import setup

entry_points = """
Christian Theune's avatar
Christian Theune committed
44 45 46 47 48 49 50 51 52 53 54
    [console_scripts]
    fsdump = ZODB.FileStorage.fsdump:main
    fsoids = ZODB.scripts.fsoids:main
    fsrefs = ZODB.scripts.fsrefs:main
    fstail = ZODB.scripts.fstail:Main
    repozo = ZODB.scripts.repozo:main
    zeopack = ZEO.scripts.zeopack:main
    runzeo = ZEO.runzeo:main
    zeopasswd = ZEO.zeopasswd:main
    mkzeoinst = ZEO.mkzeoinst:main
    zeoctl = ZEO.zeoctl:main
55
    remove-old-zeo-cached-blobs = ZEO.ClientStorage:check_blob_size_script
Christian Theune's avatar
Christian Theune committed
56
    """
57 58

scripts = []
Christian Theune's avatar
Christian Theune committed
59

60
import glob
61
import os
62
import sys
63
from setuptools.extension import Extension
64
from distutils import dir_util
65 66 67
from setuptools.dist import Distribution
from setuptools.command.install_lib import install_lib
from setuptools.command.build_py import build_py
68 69
from distutils.util import convert_path

70 71
if sys.version_info < (2, 4, 2):
    print "This version of ZODB requires Python 2.4.2 or higher"
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
    sys.exit(0)

# Include directories for C extensions
include = ['src']

# Set up dependencies for the BTrees package
base_btrees_depends = [
    "src/BTrees/BTreeItemsTemplate.c",
    "src/BTrees/BTreeModuleTemplate.c",
    "src/BTrees/BTreeTemplate.c",
    "src/BTrees/BucketTemplate.c",
    "src/BTrees/MergeTemplate.c",
    "src/BTrees/SetOpTemplate.c",
    "src/BTrees/SetTemplate.c",
    "src/BTrees/TreeSetTemplate.c",
    "src/BTrees/sorters.c",
    "src/persistent/cPersistence.h",
    ]

91
_flavors = {"O": "object", "I": "int", "F": "float", 'L': 'int'}
92 93 94 95 96 97 98 99 100 101 102 103 104

KEY_H = "src/BTrees/%skeymacros.h"
VALUE_H = "src/BTrees/%svaluemacros.h"

def BTreeExtension(flavor):
    key = flavor[0]
    value = flavor[1]
    name = "BTrees._%sBTree" % flavor
    sources = ["src/BTrees/_%sBTree.c" % flavor]
    kwargs = {"include_dirs": include}
    if flavor != "fs":
        kwargs["depends"] = (base_btrees_depends + [KEY_H % _flavors[key],
                                                    VALUE_H % _flavors[value]])
105 106
    else:
        kwargs["depends"] = base_btrees_depends
107 108 109 110 111
    if key != "O":
        kwargs["define_macros"] = [('EXCLUDE_INTSET_SUPPORT', None)]
    return Extension(name, sources, **kwargs)

exts = [BTreeExtension(flavor)
112 113 114
        for flavor in ("OO", "IO", "OI", "II", "IF",
                       "fs", "LO", "OL", "LL", "LF",
                       )]
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

cPersistence = Extension(name = 'persistent.cPersistence',
                         include_dirs = include,
                         sources= ['src/persistent/cPersistence.c',
                                   'src/persistent/ring.c'],
                         depends = ['src/persistent/cPersistence.h',
                                    'src/persistent/ring.h',
                                    'src/persistent/ring.c']
                         )

cPickleCache = Extension(name = 'persistent.cPickleCache',
                         include_dirs = include,
                         sources= ['src/persistent/cPickleCache.c',
                                   'src/persistent/ring.c'],
                         depends = ['src/persistent/cPersistence.h',
                                    'src/persistent/ring.h',
                                    'src/persistent/ring.c']
                         )

TimeStamp = Extension(name = 'persistent.TimeStamp',
                      include_dirs = include,
                      sources= ['src/persistent/TimeStamp.c']
                      )


exts += [cPersistence,
         cPickleCache,
         TimeStamp,
        ]

# The ZODB.zodb4 code is not being packaged, because it is only
# need to convert early versions of Zope3 databases to ZODB3.

packages = ["BTrees", "BTrees.tests",
149
            "ZEO", "ZEO.auth", "ZEO.zrpc", "ZEO.tests", "ZEO.scripts",
150
            "ZODB", "ZODB.FileStorage", "ZODB.tests",
151
                    "ZODB.scripts",
152 153 154 155 156 157 158 159
            "persistent", "persistent.tests",
            ]

def copy_other_files(cmd, outputbase):
    # A delicate dance to copy files with certain extensions
    # into a package just like .py files.
    extensions = ["*.conf", "*.xml", "*.txt", "*.sh"]
    directories = [
160
        "BTrees",
161 162
        "persistent/tests",
        "ZEO",
163
        "ZEO/scripts",
164
        "ZODB",
165
        "ZODB/scripts",
166
        "ZODB/tests",
167 168
        "ZODB/Blobs",
        "ZODB/Blobs/tests",
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
        ]
    for dir in directories:
        exts = extensions
        dir = convert_path(dir)
        inputdir = os.path.join("src", dir)
        outputdir = os.path.join(outputbase, dir)
        if not os.path.exists(outputdir):
            dir_util.mkpath(outputdir)
        for pattern in exts:
            for fn in glob.glob(os.path.join(inputdir, pattern)):
                # glob is going to give us a path including "src",
                # which must be stripped to get the destination dir
                dest = os.path.join(outputbase, fn[4:])
                cmd.copy_file(fn, dest)

class MyLibInstaller(install_lib):
    """Custom library installer, used to put hosttab in the right place."""
186

187 188 189 190 191
    # We use the install_lib command since we need to put hosttab
    # inside the library directory.  This is where we already have the
    # real information about where to install it after the library
    # location has been set by any relevant distutils command line
    # options.
192

193 194 195
    def run(self):
        install_lib.run(self)
        copy_other_files(self, self.install_dir)
196

197 198 199 200
class MyPyBuilder(build_py):
    def build_packages(self):
        build_py.build_packages(self)
        copy_other_files(self, self.build_lib)
201

202 203 204 205
class MyDistribution(Distribution):
    # To control the selection of MyLibInstaller and MyPyBuilder, we
    # have to set it into the cmdclass instance variable, set in
    # Distribution.__init__().
206

207 208 209 210
    def __init__(self, *attrs):
        Distribution.__init__(self, *attrs)
        self.cmdclass['build_py'] = MyPyBuilder
        self.cmdclass['install_lib'] = MyLibInstaller
211

212 213 214 215 216 217 218 219 220 221 222
def alltests():
    # use the zope.testing testrunner machinery to find all the
    # test suites we've put under ourselves
    from zope.testing.testrunner import get_options
    from zope.testing.testrunner import find_suites
    from zope.testing.testrunner import configure_logging
    configure_logging()
    from unittest import TestSuite
    here = os.path.abspath(os.path.dirname(sys.argv[0]))
    args = sys.argv[:]
    src = os.path.join(here, 'src')
223
    defaults = ['--test-path', src, '--all']
224 225 226
    options = get_options(args, defaults)
    suites = list(find_suites(options))
    return TestSuite(suites)
227

228
doclines = __doc__.split("\n")
229

230
def read_file(*path):
231
    base_dir = os.path.dirname(__file__)
232 233
    file_path = (base_dir, ) + tuple(path)
    return file(os.path.join(*file_path)).read()
234

235
setup(name="ZODB3",
236
      version=VERSION,
237 238
      maintainer="Zope Corporation",
      maintainer_email="zodb-dev@zope.org",
239
      url = "http://pypi.python.org/pypi/ZODB3",
240 241 242 243 244 245 246 247 248
      packages = packages,
      package_dir = {'': 'src'},
      ext_modules = exts,
      headers = ['src/persistent/cPersistence.h',
                 'src/persistent/ring.h'],
      license = "ZPL 2.1",
      platforms = ["any"],
      description = doclines[0],
      classifiers = filter(None, classifiers.split("\n")),
249 250 251 252
      long_description = (
        "\n".join(doclines[2:]) + "\n\n" +
        ".. contents::\n\n" + 
        read_file("README.txt")  + "\n\n" +
253
        read_file("src", "CHANGES.txt")),
254
      distclass = MyDistribution,
255 256 257 258 259 260 261 262
      test_suite="__main__.alltests", # to support "setup.py test"
      tests_require = [
        'zope.interface',
        'zope.proxy',
        'zope.testing',
        'transaction',
        'zdaemon',
        ],
263
      install_requires = [
264 265 266 267 268
        'transaction',
        'zc.lockfile',
        'ZConfig',
        'zdaemon',
        'zope.event',
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
        'zope.interface',
        'zope.proxy',
        'zope.testing',
        ],
      zip_safe = False,
      entry_points = """
      [console_scripts]
      fsdump = ZODB.FileStorage.fsdump:main
      fsoids = ZODB.scripts.fsoids:main
      fsrefs = ZODB.scripts.fsrefs:main
      fstail = ZODB.scripts.fstail:Main
      repozo = ZODB.scripts.repozo:main
      zeopack = ZEO.scripts.zeopack:main
      runzeo = ZEO.runzeo:main
      zeopasswd = ZEO.zeopasswd:main
      mkzeoinst = ZEO.mkzeoinst:main
      zeoctl = ZEO.zeoctl:main
      """,
      include_package_data = True,
      )