Merge branch 'packaging' into debian-0.8
[pithos] / snf-pithos-lib / setup.py
1 # Copyright 2011 GRNET S.A. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
5 # conditions are met:
6 #
7 #   1. Redistributions of source code must retain the above
8 #      copyright notice, this list of conditions and the following
9 #      disclaimer.
10 #
11 #   2. Redistributions in binary form must reproduce the above
12 #      copyright notice, this list of conditions and the following
13 #      disclaimer in the documentation and/or other materials
14 #      provided with the distribution.
15 #
16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
28 #
29 # The views and conclusions contained in the software and
30 # documentation are those of the authors and should not be
31 # interpreted as representing official policies, either expressed
32 # or implied, of GRNET S.A.
33 #
34
35 import distribute_setup
36 distribute_setup.use_setuptools()
37
38 import os
39
40 from distutils.util import convert_path
41 from fnmatch import fnmatchcase
42 from setuptools import setup, find_packages
43
44 HERE = os.path.abspath(os.path.normpath(os.path.dirname(__file__)))
45 try:
46     # try to update the version file
47     from synnefo.util import version
48     version.update_version('pithos.lib', 'version', HERE)
49 except ImportError:
50     pass
51
52 from pithos.lib.version import __version__
53
54 # Package info
55 VERSION = __version__
56 README = open(os.path.join(HERE, 'README')).read()
57 CHANGES = open(os.path.join(HERE, 'Changelog')).read()
58 SHORT_DESCRIPTION = 'Package short description'
59
60 PACKAGES_ROOT = '.'
61 PACKAGES = find_packages(PACKAGES_ROOT)
62
63 # Package meta
64 CLASSIFIERS = []
65
66 # Package requirements
67 INSTALL_REQUIRES = [
68 ]
69
70 EXTRAS_REQUIRES = {
71 }
72
73 TESTS_REQUIRES = [
74 ]
75
76
77 # Provided as an attribute, so you can append to these instead
78 # of replicating them:
79 standard_exclude = ["*.py", "*.pyc", "*$py.class", "*~", ".*", "*.bak"]
80 standard_exclude_directories = [
81     ".*", "CVS", "_darcs", "./build", "./dist", "EGG-INFO", "*.egg-info", "snf-0.7"
82 ]
83
84 # (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
85 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
86 # Note: you may want to copy this into your setup.py file verbatim, as
87 # you can't import this from another package, when you don't know if
88 # that package is installed yet.
89 def find_package_data(
90     where=".",
91     package="",
92     exclude=standard_exclude,
93     exclude_directories=standard_exclude_directories,
94     only_in_packages=True,
95     show_ignored=False):
96     """
97     Return a dictionary suitable for use in ``package_data``
98     in a distutils ``setup.py`` file.
99
100     The dictionary looks like::
101
102         {"package": [files]}
103
104     Where ``files`` is a list of all the files in that package that
105     don"t match anything in ``exclude``.
106
107     If ``only_in_packages`` is true, then top-level directories that
108     are not packages won"t be included (but directories under packages
109     will).
110
111     Directories matching any pattern in ``exclude_directories`` will
112     be ignored; by default directories with leading ``.``, ``CVS``,
113     and ``_darcs`` will be ignored.
114
115     If ``show_ignored`` is true, then all the files that aren"t
116     included in package data are shown on stderr (for debugging
117     purposes).
118
119     Note patterns use wildcards, or can be exact paths (including
120     leading ``./``), and all searching is case-insensitive.
121     """
122     out = {}
123     stack = [(convert_path(where), "", package, only_in_packages)]
124     while stack:
125         where, prefix, package, only_in_packages = stack.pop(0)
126         for name in os.listdir(where):
127             fn = os.path.join(where, name)
128             if os.path.isdir(fn):
129                 bad_name = False
130                 for pattern in exclude_directories:
131                     if (fnmatchcase(name, pattern)
132                         or fn.lower() == pattern.lower()):
133                         bad_name = True
134                         if show_ignored:
135                             print >> sys.stderr, (
136                                 "Directory %s ignored by pattern %s"
137                                 % (fn, pattern))
138                         break
139                 if bad_name:
140                     continue
141                 if (os.path.isfile(os.path.join(fn, "__init__.py"))
142                     and not prefix):
143                     if not package:
144                         new_package = name
145                     else:
146                         new_package = package + "." + name
147                     stack.append((fn, "", new_package, False))
148                 else:
149                     stack.append((fn, prefix + name + "/", package, only_in_packages))
150             elif package or not only_in_packages:
151                 # is a file
152                 bad_name = False
153                 for pattern in exclude:
154                     if (fnmatchcase(name, pattern)
155                         or fn.lower() == pattern.lower()):
156                         bad_name = True
157                         if show_ignored:
158                             print >> sys.stderr, (
159                                 "File %s ignored by pattern %s"
160                                 % (fn, pattern))
161                         break
162                 if bad_name:
163                     continue
164                 out.setdefault(package, []).append(prefix+name)
165     return out
166
167 setup(
168     name = 'snf-pithos-lib',
169     version = VERSION,
170     license = 'BSD',
171     url = 'http://code.grnet.gr/',
172     description = SHORT_DESCRIPTION,
173     long_description=README + '\n\n' +  CHANGES,
174     classifiers = CLASSIFIERS,
175
176     author = 'Package author',
177     author_email = 'author@grnet.gr',
178     maintainer = 'Package maintainer',
179     maintainer_email = 'maintainer@grnet.gr',
180
181     namespace_packages = ['pithos'],
182     packages = PACKAGES,
183     package_dir= {'': PACKAGES_ROOT},
184     include_package_data = True,
185     package_data = find_package_data('.'),
186     zip_safe = False,
187
188     dependency_links = [
189         'http://docs.dev.grnet.gr/pypi/'],
190
191     install_requires = INSTALL_REQUIRES,
192     extras_require = EXTRAS_REQUIRES,
193     tests_require = TESTS_REQUIRES,
194
195     entry_points = {
196      'console_scripts': [
197          ],
198       },
199 )
200