setup.py changes
[pithos] / snf-pithos-tools / 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.tools', 'version', HERE)
49 except ImportError:
50     pass
51
52 from pithos.tools.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     'snf-pithos-lib'
69 ]
70
71 EXTRAS_REQUIRES = {
72 }
73
74 TESTS_REQUIRES = [
75 ]
76
77
78 # Provided as an attribute, so you can append to these instead
79 # of replicating them:
80 standard_exclude = ["*.py", "*.pyc", "*$py.class", "*~", ".*", "*.bak"]
81 standard_exclude_directories = [
82     ".*", "CVS", "_darcs", "./build", "./dist", "EGG-INFO", "*.egg-info", "snf-0.7"
83 ]
84
85 # (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
86 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
87 # Note: you may want to copy this into your setup.py file verbatim, as
88 # you can't import this from another package, when you don't know if
89 # that package is installed yet.
90 def find_package_data(
91     where=".",
92     package="",
93     exclude=standard_exclude,
94     exclude_directories=standard_exclude_directories,
95     only_in_packages=True,
96     show_ignored=False):
97     """
98     Return a dictionary suitable for use in ``package_data``
99     in a distutils ``setup.py`` file.
100
101     The dictionary looks like::
102
103         {"package": [files]}
104
105     Where ``files`` is a list of all the files in that package that
106     don"t match anything in ``exclude``.
107
108     If ``only_in_packages`` is true, then top-level directories that
109     are not packages won"t be included (but directories under packages
110     will).
111
112     Directories matching any pattern in ``exclude_directories`` will
113     be ignored; by default directories with leading ``.``, ``CVS``,
114     and ``_darcs`` will be ignored.
115
116     If ``show_ignored`` is true, then all the files that aren"t
117     included in package data are shown on stderr (for debugging
118     purposes).
119
120     Note patterns use wildcards, or can be exact paths (including
121     leading ``./``), and all searching is case-insensitive.
122     """
123     out = {}
124     stack = [(convert_path(where), "", package, only_in_packages)]
125     while stack:
126         where, prefix, package, only_in_packages = stack.pop(0)
127         for name in os.listdir(where):
128             fn = os.path.join(where, name)
129             if os.path.isdir(fn):
130                 bad_name = False
131                 for pattern in exclude_directories:
132                     if (fnmatchcase(name, pattern)
133                         or fn.lower() == pattern.lower()):
134                         bad_name = True
135                         if show_ignored:
136                             print >> sys.stderr, (
137                                 "Directory %s ignored by pattern %s"
138                                 % (fn, pattern))
139                         break
140                 if bad_name:
141                     continue
142                 if (os.path.isfile(os.path.join(fn, "__init__.py"))
143                     and not prefix):
144                     if not package:
145                         new_package = name
146                     else:
147                         new_package = package + "." + name
148                     stack.append((fn, "", new_package, False))
149                 else:
150                     stack.append((fn, prefix + name + "/", package, only_in_packages))
151             elif package or not only_in_packages:
152                 # is a file
153                 bad_name = False
154                 for pattern in exclude:
155                     if (fnmatchcase(name, pattern)
156                         or fn.lower() == pattern.lower()):
157                         bad_name = True
158                         if show_ignored:
159                             print >> sys.stderr, (
160                                 "File %s ignored by pattern %s"
161                                 % (fn, pattern))
162                         break
163                 if bad_name:
164                     continue
165                 out.setdefault(package, []).append(prefix+name)
166     return out
167
168 setup(
169     name = 'snf-pithos-tools',
170     version = VERSION,
171     license = 'BSD',
172     url = 'http://code.grnet.gr/',
173     description = SHORT_DESCRIPTION,
174     long_description=README + '\n\n' +  CHANGES,
175     classifiers = CLASSIFIERS,
176
177     author = 'Package author',
178     author_email = 'author@grnet.gr',
179     maintainer = 'Package maintainer',
180     maintainer_email = 'maintainer@grnet.gr',
181
182     namespace_packages = ['pithos'],
183     packages = PACKAGES,
184     package_dir= {'': PACKAGES_ROOT},
185     include_package_data = True,
186     package_data = find_package_data('.'),
187     zip_safe = False,
188
189     dependency_links = [
190         'http://docs.dev.grnet.gr/pypi/'],
191
192     install_requires = INSTALL_REQUIRES,
193     extras_require = EXTRAS_REQUIRES,
194     tests_require = TESTS_REQUIRES,
195
196     entry_points = {
197      'console_scripts': [
198          'pithos-sh = pithos.tools.sh:main',
199          'pithos-sync = pithos.tools.sync:main',
200          'pithos-test = pithos.tools.test:main',
201          'pithos-fs = pithos.tools.fs:main',
202          'pithos-dispatcher = pithos.tools.dispatcher:main',
203          ],
204       },
205 )
206