pkginfo cleanup, setuptools enabled setup.py stable
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 23 Apr 2010 16:56:02 +0200
branchstable
changeset 197 a149c357550b
parent 196 18b619f80a89
child 198 49e43eeec302
pkginfo cleanup, setuptools enabled setup.py
README
__pkginfo__.py
setup.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Apr 23 16:56:02 2010 +0200
@@ -0,0 +1,42 @@
+Summary
+-------
+The `blog` cube provides blogging functionnalities. It creates two entity types,
+`Blog` and `BlogEntry`. There are related to each other by the relation
+`BlogEntry entry_of Blog`.
+
+Usage
+-----
+
+When a user submits a blog entry, it goes in a `draft` state until the blog
+entry is published by an application managers. The blog entry will not be
+visible until it reaches the `published` state.
+
+When a blog entry is submitted, an email notification is automatically sent
+to all the users belonging to the `managers` group of the application.
+
+Specific boxes provided by this cube:
+
+- `BlogEntryArchiveBox`, displays a box with the total number of blog entries
+  submitted by month for the last twelve months.
+
+- `BlogEntryListBox`, displays a box with the latest five blog entries
+  published in your application as well as link to subscribe to a RSS feed.
+
+- `BlogEntrySummary`, displays a box with the list of users who submitted
+  blog entries and the total number of blog entries they submitted.
+
+This cube also provides some web services such as:
+
+- http://xx:xxxx/blogentries/YYYY to retrieve the blog entries submitted
+  during the year YYYY through a RSS feed
+
+- http://xx:xxxx/blogentries/YYYY/MM to retrieve the blog entries submitted
+  during the month MM of the year YYYY through a RSS feed
+
+- http://xx:xxxx/blog/[eid]/blogentries/YYYY to retrieve the blog entries
+  submitted in the blog of identifier [eid], during the year YYYY through
+  a RSS feed
+
+- http://xx:xxxx/blog/[eid]/blogentries/YYYY/MM to retrieve the blog entries
+  submitted in the blog of identifier [eid], during the month MM of the
+  year YYYY through a RSS feed
--- a/__pkginfo__.py	Fri Apr 23 16:53:20 2010 +0200
+++ b/__pkginfo__.py	Fri Apr 23 16:56:02 2010 +0200
@@ -13,51 +13,8 @@
 author_email = "contact@logilab.fr"
 web = 'http://www.cubicweb.org/project/%s' % distname
 
-short_desc = "blogging component for the CubicWeb framework"
-long_desc = """\
-Summary
--------
-The `blog` cube provides blogging functionnalities. It creates two entity types,
-`Blog` and `BlogEntry`. There are related to each other by the relation
-`BlogEntry entry_of Blog`.
-
-Usage
------
-
-When a user submits a blog entry, it goes in a `draft` state until the blog
-entry is published by an application managers. The blog entry will not be
-visible until it reaches the `published` state.
-
-When a blog entry is submitted, an email notification is automatically sent
-to all the users belonging to the `managers` group of the application.
-
-Specific boxes provided by this cube:
-
-- `BlogEntryArchiveBox`, displays a box with the total number of blog entries
-  submitted by month for the last twelve months.
-
-- `BlogEntryListBox`, displays a box with the latest five blog entries
-  published in your application as well as link to subscribe to a RSS feed.
-
-- `BlogEntrySummary`, displays a box with the list of users who submitted
-  blog entries and the total number of blog entries they submitted.
-
-This cube also provides some web services such as:
-
-- http://xx:xxxx/blogentries/YYYY to retrieve the blog entries submitted
-  during the year YYYY through a RSS feed
-
-- http://xx:xxxx/blogentries/YYYY/MM to retrieve the blog entries submitted
-  during the month MM of the year YYYY through a RSS feed
-
-- http://xx:xxxx/blog/[eid]/blogentries/YYYY to retrieve the blog entries
-  submitted in the blog of identifier [eid], during the year YYYY through
-  a RSS feed
-
-- http://xx:xxxx/blog/[eid]/blogentries/YYYY/MM to retrieve the blog entries
-  submitted in the blog of identifier [eid], during the month MM of the
-  year YYYY through a RSS feed
-"""
+description = "blogging component for the CubicWeb framework"
+short_desc = description # XXX cw < 3.8 bw compat
 
 classifiers = [
     'Environment :: Web Environment'
@@ -73,6 +30,7 @@
 for cube in __recommends_cubes__:
     __recommends__['cubicweb-'+cube] = __recommends_cubes__[cube]
 
+
 # package ###
 
 from os import listdir as _listdir
--- a/setup.py	Fri Apr 23 16:53:20 2010 +0200
+++ b/setup.py	Fri Apr 23 16:56:02 2010 +0200
@@ -1,50 +1,170 @@
 #!/usr/bin/env python
 # pylint: disable-msg=W0404,W0622,W0704,W0613,W0152
-# Copyright (c) 2003-2004 LOGILAB S.A. (Paris, FRANCE).
-# http://www.logilab.fr/ -- mailto:contact@logilab.fr
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-""" Generic Setup script, takes package info from __pkginfo__.py file """
+"""Generic Setup script, takes package info from __pkginfo__.py file.
+
+:copyright: 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
+:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
+"""
+__docformat__ = "restructuredtext en"
+
+import os
+import sys
+import shutil
+from os.path import isdir, exists, join, walk
 
-from distutils.core import setup
+try:
+    if os.environ.get('NO_SETUPTOOLS'):
+        raise ImportError()
+    from setuptools import setup
+    from setuptools.command import install_lib
+    USE_SETUPTOOLS = 1
+except ImportError:
+    from distutils.core import setup
+    from distutils.command import install_lib
+    USE_SETUPTOOLS = 0
 
+
+sys.modules.pop('__pkginfo__', None)
 # import required features
-from __pkginfo__ import distname, version, license, short_desc, long_desc, \
+from __pkginfo__ import modname, version, license, description, \
      web, author, author_email
 # import optional features
-try:
-    from __pkginfo__ import data_files
-except ImportError:
-    data_files = None
-try:
-    from __pkginfo__ import include_dirs
-except ImportError:
-    include_dirs = []
+import __pkginfo__
+distname = getattr(__pkginfo__, 'distname', modname)
+scripts = getattr(__pkginfo__, 'scripts', [])
+data_files = getattr(__pkginfo__, 'data_files', None)
+include_dirs = getattr(__pkginfo__, 'include_dirs', [])
+ext_modules = getattr(__pkginfo__, 'ext_modules', None)
+dependency_links = getattr(__pkginfo__, 'dependency_links', [])
+
+STD_BLACKLIST = ('CVS', '.svn', '.hg', 'debian', 'dist', 'build')
+
+IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
+
+if exists('README'):
+    long_description = file('README').read()
+else:
+    long_description = ''
+if USE_SETUPTOOLS:
+   requires = {}
+   for entry in ("__depends__", "__recommends__"):
+      requires.update(getattr(__pkginfo__, entry, {}))
+   install_requires = [("%s %s" % (d, v and v or "")).strip()
+                       for d, v in requires.iteritems()]
+else:
+   install_requires = []
+
+
+def ensure_scripts(linux_scripts):
+    """Creates the proper script names required for each platform
+    (taken from 4Suite)
+    """
+    from distutils import util
+    if util.get_platform()[:3] == 'win':
+        scripts_ = [script + '.bat' for script in linux_scripts]
+    else:
+        scripts_ = linux_scripts
+    return scripts_
+
+def get_packages(directory, prefix):
+    """return a list of subpackages for the given directory"""
+    result = []
+    for package in os.listdir(directory):
+        absfile = join(directory, package)
+        if isdir(absfile):
+            if exists(join(absfile, '__init__.py')) or \
+                   package in ('test', 'tests'):
+                if prefix:
+                    result.append('%s.%s' % (prefix, package))
+                else:
+                    result.append(package)
+                result += get_packages(absfile, result[-1])
+    return result
+
+def export(from_dir, to_dir,
+           blacklist=STD_BLACKLIST,
+           ignore_ext=IGNORED_EXTENSIONS,
+           verbose=True):
+    """make a mirror of from_dir in to_dir, omitting directories and files
+    listed in the black list
+    """
+    def make_mirror(arg, directory, fnames):
+        """walk handler"""
+        for norecurs in blacklist:
+            try:
+                fnames.remove(norecurs)
+            except ValueError:
+                pass
+        for filename in fnames:
+            # don't include binary files
+            if filename[-4:] in ignore_ext:
+                continue
+            if filename[-1] == '~':
+                continue
+            src = join(directory, filename)
+            dest = to_dir + src[len(from_dir):]
+            if verbose:
+                print >> sys.stderr, src, '->', dest
+            if os.path.isdir(src):
+                if not exists(dest):
+                    os.mkdir(dest)
+            else:
+                if exists(dest):
+                    os.remove(dest)
+                shutil.copy2(src, dest)
+    try:
+        os.mkdir(to_dir)
+    except OSError, ex:
+        # file exists ?
+        import errno
+        if ex.errno != errno.EEXIST:
+            raise
+    walk(from_dir, make_mirror, None)
+
+
+class MyInstallLib(install_lib.install_lib):
+    """extend install_lib command to handle  package __init__.py and
+    include_dirs variable if necessary
+    """
+    def run(self):
+        """overridden from install_lib class"""
+        install_lib.install_lib.run(self)
+        # manually install included directories if any
+        if include_dirs:
+            base = modname
+            for directory in include_dirs:
+                dest = join(self.install_dir, base, directory)
+                export(directory, dest, verbose=False)
 
 def install(**kwargs):
     """setup entry point"""
-    #kwargs['distname'] = modname
-    return setup(name=distname,
-                 version=version,
-                 license=license,
-                 description=short_desc,
-                 long_description=long_desc,
-                 author=author,
-                 author_email=author_email,
-                 url=web,
-                 data_files=data_files,
-                 **kwargs)
-            
+    if USE_SETUPTOOLS:
+        if '--force-manifest' in sys.argv:
+            sys.argv.remove('--force-manifest')
+    # install-layout option was introduced in 2.5.3-1~exp1
+    elif sys.version_info < (2, 5, 4) and '--install-layout=deb' in sys.argv:
+        sys.argv.remove('--install-layout=deb')
+    kwargs['package_dir'] = {modname : '.'}
+    packages = [modname] + get_packages(os.getcwd(), modname)
+    if USE_SETUPTOOLS and install_requires:
+        kwargs['install_requires'] = install_requires
+        kwargs['dependency_links'] = dependency_links
+    kwargs['packages'] = packages
+    return setup(name = distname,
+                 version = version,
+                 license = license,
+                 description = description,
+                 long_description = long_description,
+                 author = author,
+                 author_email = author_email,
+                 url = web,
+                 scripts = ensure_scripts(scripts),
+                 data_files = data_files,
+                 ext_modules = ext_modules,
+                 cmdclass = {'install_lib': MyInstallLib},
+                 **kwargs
+                 )
+
 if __name__ == '__main__' :
     install()