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