[saem-devel] [PATCH 5 of 6] [pkg] Move to new "cube as package" layout allowed by cubicweb 3.24

Sylvain Thenault sylvain.thenault at logilab.fr
Fri Jan 27 14:50:20 CET 2017


# HG changeset patch
# User Denis Laxalde <denis.laxalde at logilab.fr>
# Date 1468340638 -7200
#      Tue Jul 12 18:23:58 2016 +0200
# Node ID 529af6659bd62d0894f18dfe92b90db30eea6729
# Parent  c54305d4d23506851abf5a69f2c6f11f0756bb75
[pkg] Move to new "cube as package" layout allowed by cubicweb 3.24

which is now a dependancy.

diff --git a/__init__.py b/cubicweb_saem_ref/__init__.py
rename from __init__.py
rename to cubicweb_saem_ref/__init__.py
diff --git a/__pkginfo__.py b/cubicweb_saem_ref/__pkginfo__.py
rename from __pkginfo__.py
rename to cubicweb_saem_ref/__pkginfo__.py
--- a/__pkginfo__.py
+++ b/cubicweb_saem_ref/__pkginfo__.py
@@ -1,13 +1,9 @@
 # coding: utf-8
 # pylint: disable=W0622
 """cubicweb-saem-ref application packaging information"""
 
-from os import listdir as _listdir
-from os.path import join, isdir
-from glob import glob
-
 modname = 'saem_ref'
 distname = 'cubicweb-saem-ref'
 
 numversion = (0, 14, 0)
 version = '.'.join(str(num) for num in numversion) + '.pre0'
@@ -17,12 +13,11 @@ author = 'LOGILAB S.A. (Paris, FRANCE)'
 author_email = 'contact at logilab.fr'
 description = "Référenciel de Système d'Archivage Électronique Mutualisé"
 web = 'http://www.cubicweb.org/project/%s' % distname
 
 __depends__ = {
-    'cubicweb': '>= 3.24.0',
-    'cubicweb[pyramid]': None,
+    'cubicweb[pyramid]': '>= 3.24.0',
     'cubicweb-squareui': None,
     'cubicweb-eac': None,
     'cubicweb-seda': '>= 0.5.1',
     'cubicweb-compound': '>= 0.3.0',
     'cubicweb-oaipmh': '>= 0.3.0',
@@ -42,29 +37,5 @@ classifiers = [
     'Environment :: Web Environment',
     'Framework :: CubicWeb',
     'Programming Language :: Python',
     'Programming Language :: JavaScript',
 ]
-
-THIS_CUBE_DIR = join('share', 'cubicweb', 'cubes', modname)
-
-
-def listdir(dirpath):
-    return [join(dirpath, fname) for fname in _listdir(dirpath)
-            if fname[0] != '.' and not fname.endswith('.pyc')
-            and not fname.endswith('~')
-            and not isdir(join(dirpath, fname))]
-
-
-data_files = [
-    # common files
-    [THIS_CUBE_DIR, [fname for fname in glob('*.py') if fname != 'setup.py']],
-    [THIS_CUBE_DIR, [fname for fname in glob('*.txt')]],
-]
-# check for possible extended cube layout
-for dname in ('entities', 'views', 'sobjects', 'hooks', 'schema', 'data',
-              'wdoc', 'i18n', 'migration', 'lib', 'dataimport', 'scripts',
-              'migration/data'):
-    if isdir(dname):
-        data_files.append([join(THIS_CUBE_DIR, dname), listdir(dname)])
-# Note: here, you'll need to add subdirectories if you want
-# them to be included in the debian package
diff --git a/ccplugin.py b/cubicweb_saem_ref/ccplugin.py
rename from ccplugin.py
rename to cubicweb_saem_ref/ccplugin.py
diff --git a/data/bandeau_saem.jpg b/cubicweb_saem_ref/data/bandeau_saem.jpg
rename from data/bandeau_saem.jpg
rename to cubicweb_saem_ref/data/bandeau_saem.jpg
diff --git a/data/bx_metro.jpg b/cubicweb_saem_ref/data/bx_metro.jpg
rename from data/bx_metro.jpg
rename to cubicweb_saem_ref/data/bx_metro.jpg
diff --git a/data/cd33.jpg b/cubicweb_saem_ref/data/cd33.jpg
rename from data/cd33.jpg
rename to cubicweb_saem_ref/data/cd33.jpg
diff --git a/data/cubes.saem_ref.css b/cubicweb_saem_ref/data/cubes.saem_ref.css
rename from data/cubes.saem_ref.css
rename to cubicweb_saem_ref/data/cubes.saem_ref.css
diff --git a/data/cubes.saem_ref.js b/cubicweb_saem_ref/data/cubes.saem_ref.js
rename from data/cubes.saem_ref.js
rename to cubicweb_saem_ref/data/cubes.saem_ref.js
diff --git a/data/cubicweb.autocompletesearch.js b/cubicweb_saem_ref/data/cubicweb.autocompletesearch.js
rename from data/cubicweb.autocompletesearch.js
rename to cubicweb_saem_ref/data/cubicweb.autocompletesearch.js
diff --git a/data/jquery.expander.js b/cubicweb_saem_ref/data/jquery.expander.js
rename from data/jquery.expander.js
rename to cubicweb_saem_ref/data/jquery.expander.js
diff --git a/data/jquery.highlight.js b/cubicweb_saem_ref/data/jquery.highlight.js
rename from data/jquery.highlight.js
rename to cubicweb_saem_ref/data/jquery.highlight.js
diff --git a/data/jquery.jOrgChart.css b/cubicweb_saem_ref/data/jquery.jOrgChart.css
rename from data/jquery.jOrgChart.css
rename to cubicweb_saem_ref/data/jquery.jOrgChart.css
diff --git a/data/jquery.jOrgChart.js b/cubicweb_saem_ref/data/jquery.jOrgChart.js
rename from data/jquery.jOrgChart.js
rename to cubicweb_saem_ref/data/jquery.jOrgChart.js
diff --git a/data/logo_saem.png b/cubicweb_saem_ref/data/logo_saem.png
rename from data/logo_saem.png
rename to cubicweb_saem_ref/data/logo_saem.png
diff --git a/data/mairie_bx.jpg b/cubicweb_saem_ref/data/mairie_bx.jpg
rename from data/mairie_bx.jpg
rename to cubicweb_saem_ref/data/mairie_bx.jpg
diff --git a/entities/__init__.py b/cubicweb_saem_ref/entities/__init__.py
rename from entities/__init__.py
rename to cubicweb_saem_ref/entities/__init__.py
diff --git a/entities/container.py b/cubicweb_saem_ref/entities/container.py
rename from entities/container.py
rename to cubicweb_saem_ref/entities/container.py
diff --git a/entities/eac.py b/cubicweb_saem_ref/entities/eac.py
rename from entities/eac.py
rename to cubicweb_saem_ref/entities/eac.py
diff --git a/entities/oai.py b/cubicweb_saem_ref/entities/oai.py
rename from entities/oai.py
rename to cubicweb_saem_ref/entities/oai.py
diff --git a/entities/org.py b/cubicweb_saem_ref/entities/org.py
rename from entities/org.py
rename to cubicweb_saem_ref/entities/org.py
diff --git a/entities/rdf.py b/cubicweb_saem_ref/entities/rdf.py
rename from entities/rdf.py
rename to cubicweb_saem_ref/entities/rdf.py
diff --git a/entities/seda.py b/cubicweb_saem_ref/entities/seda.py
rename from entities/seda.py
rename to cubicweb_saem_ref/entities/seda.py
diff --git a/entities/skos.py b/cubicweb_saem_ref/entities/skos.py
rename from entities/skos.py
rename to cubicweb_saem_ref/entities/skos.py
diff --git a/hooks.py b/cubicweb_saem_ref/hooks.py
rename from hooks.py
rename to cubicweb_saem_ref/hooks.py
diff --git a/i18n/en.po b/cubicweb_saem_ref/i18n/en.po
rename from i18n/en.po
rename to cubicweb_saem_ref/i18n/en.po
diff --git a/i18n/fr.po b/cubicweb_saem_ref/i18n/fr.po
rename from i18n/fr.po
rename to cubicweb_saem_ref/i18n/fr.po
diff --git a/i18n/static-messages.pot b/cubicweb_saem_ref/i18n/static-messages.pot
rename from i18n/static-messages.pot
rename to cubicweb_saem_ref/i18n/static-messages.pot
diff --git a/migration/0.12.0_Any.py b/cubicweb_saem_ref/migration/0.12.0_Any.py
rename from migration/0.12.0_Any.py
rename to cubicweb_saem_ref/migration/0.12.0_Any.py
diff --git a/migration/0.12.2_Any.py b/cubicweb_saem_ref/migration/0.12.2_Any.py
rename from migration/0.12.2_Any.py
rename to cubicweb_saem_ref/migration/0.12.2_Any.py
diff --git a/migration/0.13.0_Any.py b/cubicweb_saem_ref/migration/0.13.0_Any.py
rename from migration/0.13.0_Any.py
rename to cubicweb_saem_ref/migration/0.13.0_Any.py
diff --git a/migration/0.13.1_Any.py b/cubicweb_saem_ref/migration/0.13.1_Any.py
rename from migration/0.13.1_Any.py
rename to cubicweb_saem_ref/migration/0.13.1_Any.py
diff --git a/migration/0.14.0_Any.py b/cubicweb_saem_ref/migration/0.14.0_Any.py
rename from migration/0.14.0_Any.py
rename to cubicweb_saem_ref/migration/0.14.0_Any.py
diff --git a/migration/postcreate.py b/cubicweb_saem_ref/migration/postcreate.py
rename from migration/postcreate.py
rename to cubicweb_saem_ref/migration/postcreate.py
diff --git a/pg_trgm.py b/cubicweb_saem_ref/pg_trgm.py
rename from pg_trgm.py
rename to cubicweb_saem_ref/pg_trgm.py
diff --git a/pviews.py b/cubicweb_saem_ref/pviews.py
rename from pviews.py
rename to cubicweb_saem_ref/pviews.py
diff --git a/schema.py b/cubicweb_saem_ref/schema.py
rename from schema.py
rename to cubicweb_saem_ref/schema.py
diff --git a/scripts/init_data_culture.py b/cubicweb_saem_ref/scripts/init_data_culture.py
rename from scripts/init_data_culture.py
rename to cubicweb_saem_ref/scripts/init_data_culture.py
diff --git a/scripts/init_logilab_agent.py b/cubicweb_saem_ref/scripts/init_logilab_agent.py
rename from scripts/init_logilab_agent.py
rename to cubicweb_saem_ref/scripts/init_logilab_agent.py
diff --git a/site_cubicweb.py b/cubicweb_saem_ref/site_cubicweb.py
rename from site_cubicweb.py
rename to cubicweb_saem_ref/site_cubicweb.py
diff --git a/sobjects/__init__.py b/cubicweb_saem_ref/sobjects/__init__.py
rename from sobjects/__init__.py
rename to cubicweb_saem_ref/sobjects/__init__.py
diff --git a/sobjects/skos.py b/cubicweb_saem_ref/sobjects/skos.py
rename from sobjects/skos.py
rename to cubicweb_saem_ref/sobjects/skos.py
diff --git a/uiprops.py b/cubicweb_saem_ref/uiprops.py
rename from uiprops.py
rename to cubicweb_saem_ref/uiprops.py
diff --git a/views/__init__.py b/cubicweb_saem_ref/views/__init__.py
rename from views/__init__.py
rename to cubicweb_saem_ref/views/__init__.py
diff --git a/views/authorityrecord.py b/cubicweb_saem_ref/views/authorityrecord.py
rename from views/authorityrecord.py
rename to cubicweb_saem_ref/views/authorityrecord.py
diff --git a/views/autocompletesearch.py b/cubicweb_saem_ref/views/autocompletesearch.py
rename from views/autocompletesearch.py
rename to cubicweb_saem_ref/views/autocompletesearch.py
diff --git a/views/clone.py b/cubicweb_saem_ref/views/clone.py
rename from views/clone.py
rename to cubicweb_saem_ref/views/clone.py
diff --git a/views/eac.py b/cubicweb_saem_ref/views/eac.py
rename from views/eac.py
rename to cubicweb_saem_ref/views/eac.py
diff --git a/views/management.py b/cubicweb_saem_ref/views/management.py
rename from views/management.py
rename to cubicweb_saem_ref/views/management.py
diff --git a/views/org.py b/cubicweb_saem_ref/views/org.py
rename from views/org.py
rename to cubicweb_saem_ref/views/org.py
diff --git a/views/patches.py b/cubicweb_saem_ref/views/patches.py
rename from views/patches.py
rename to cubicweb_saem_ref/views/patches.py
diff --git a/views/prov.py b/cubicweb_saem_ref/views/prov.py
rename from views/prov.py
rename to cubicweb_saem_ref/views/prov.py
diff --git a/views/rdf.py b/cubicweb_saem_ref/views/rdf.py
rename from views/rdf.py
rename to cubicweb_saem_ref/views/rdf.py
diff --git a/views/search.py b/cubicweb_saem_ref/views/search.py
rename from views/search.py
rename to cubicweb_saem_ref/views/search.py
diff --git a/views/seda.py b/cubicweb_saem_ref/views/seda.py
rename from views/seda.py
rename to cubicweb_saem_ref/views/seda.py
diff --git a/views/skos.py b/cubicweb_saem_ref/views/skos.py
rename from views/skos.py
rename to cubicweb_saem_ref/views/skos.py
diff --git a/views/startup.py b/cubicweb_saem_ref/views/startup.py
rename from views/startup.py
rename to cubicweb_saem_ref/views/startup.py
diff --git a/views/widgets.py b/cubicweb_saem_ref/views/widgets.py
rename from views/widgets.py
rename to cubicweb_saem_ref/views/widgets.py
diff --git a/views/ws.py b/cubicweb_saem_ref/views/ws.py
rename from views/ws.py
rename to cubicweb_saem_ref/views/ws.py
diff --git a/workflows.py b/cubicweb_saem_ref/workflows.py
rename from workflows.py
rename to cubicweb_saem_ref/workflows.py
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -1,12 +1,12 @@
 #!/usr/bin/env python
-# pylint: skip-file
+# pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
 #
-# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 # contact http://www.logilab.fr/ -- mailto:contact at logilab.fr
 #
-# This file is part of CubicWeb tag cube.
+# This file is part of a cubicweb-saem-ref.
 #
 # CubicWeb is free software: you can redistribute it and/or modify it under the
 # terms of the GNU Lesser General Public License as published by the Free
 # Software Foundation, either version 2.1 of the License, or (at your option)
 # any later version.
@@ -14,188 +14,69 @@
 # CubicWeb 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 Lesser General Public License for more
 # details.
 #
-# You should have received a copy of the GNU Lesser General Public License along
-# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
-"""Generic Setup script, takes package info from __pkginfo__.py file
+# You should have received a copy of the GNU Lesser General Public License
+# along with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
+"""cubicweb_saem_ref setup module using data from
+cubicweb_saem_ref/__pkginfo__.py file
 """
-__docformat__ = "restructuredtext en"
-
-import os
-import sys
-import shutil
-from os.path import exists, join, walk
-
-try:
-    if os.environ.get('NO_SETUPTOOLS'):
-        raise ImportError() # do as there is no setuptools
-    from setuptools import setup
-    from setuptools.command import install_lib
-    USE_SETUPTOOLS = True
-except ImportError:
-    from distutils.core import setup
-    from distutils.command import install_lib
-    USE_SETUPTOOLS = False
-from distutils.command import install_data
 
-# import required features
-from __pkginfo__ import modname, version, license, description, web, \
-     author, author_email, classifiers
-
-if exists('README'):
-    long_description = file('README').read()
-else:
-    long_description = ''
+from os.path import join, dirname
 
-# import optional features
-import __pkginfo__
-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 = []
-
-distname = getattr(__pkginfo__, 'distname', modname)
-scripts = getattr(__pkginfo__, 'scripts', ())
-include_dirs = getattr(__pkginfo__, 'include_dirs', ())
-data_files = getattr(__pkginfo__, 'data_files', None)
-ext_modules = getattr(__pkginfo__, 'ext_modules', None)
-dependency_links = getattr(__pkginfo__, 'dependency_links', ())
-
-BASE_BLACKLIST = ('CVS', '.svn', '.hg', 'debian', 'dist', 'build')
-IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
+from setuptools import find_packages, setup
 
 
-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_
+here = dirname(__file__)
 
-def export(from_dir, to_dir,
-           blacklist=BASE_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:
-                sys.stderr.write('%s -> %s\n' % (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 as ex:
-        # file exists ?
-        import errno
-        if ex.errno != errno.EEXIST:
-            raise
-    walk(from_dir, make_mirror, None)
+# load metadata from the __pkginfo__.py file so there is no risk of conflict
+# see https://packaging.python.org/en/latest/single_source_version.html
+pkginfo = join(here, 'cubicweb_saem_ref', '__pkginfo__.py')
+__pkginfo__ = {}
+with open(pkginfo) as f:
+    exec(f.read(), __pkginfo__)
+
+# get required metadatas
+distname = __pkginfo__['distname']
+version = __pkginfo__['version']
+license = __pkginfo__['license']
+description = __pkginfo__['description']
+web = __pkginfo__['web']
+author = __pkginfo__['author']
+author_email = __pkginfo__['author_email']
+classifiers = __pkginfo__['classifiers']
+
+with open(join(here, 'README')) as f:
+    long_description = f.read()
+
+# get optional metadatas
+data_files = __pkginfo__.get('data_files', None)
+dependency_links = __pkginfo__.get('dependency_links', ())
+
+requires = {}
+for entry in ("__depends__",):  # "__recommends__"):
+    requires.update(__pkginfo__.get(entry, {}))
+install_requires = ["{0} {1}".format(d, v and v or "").strip()
+                    for d, v in requires.items()]
 
 
-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)
-
-# re-enable copying data files in sys.prefix
-old_install_data = install_data.install_data
-if USE_SETUPTOOLS:
-    # overwrite InstallData to use sys.prefix instead of the egg directory
-    class MyInstallData(old_install_data):
-        """A class that manages data files installation"""
-        def run(self):
-            _old_install_dir = self.install_dir
-            if self.install_dir.endswith('egg'):
-                self.install_dir = sys.prefix
-            old_install_data.run(self)
-            self.install_dir = _old_install_dir
-    try:
-        import setuptools.command.easy_install # only if easy_install available
-        # monkey patch: Crack SandboxViolation verification
-        from setuptools.sandbox import DirectorySandbox as DS
-        old_ok = DS._ok
-        def _ok(self, path):
-            """Return True if ``path`` can be written during installation."""
-            out = old_ok(self, path) # here for side effect from setuptools
-            realpath = os.path.normcase(os.path.realpath(path))
-            allowed_path = os.path.normcase(sys.prefix)
-            if realpath.startswith(allowed_path):
-                out = True
-            return out
-        DS._ok = _ok
-    except ImportError:
-        pass
-
-def install(**kwargs):
-    """setup entry point"""
-    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')
-    cmdclass = {'install_lib': MyInstallLib}
-    if USE_SETUPTOOLS:
-        kwargs['install_requires'] = install_requires
-        kwargs['dependency_links'] = dependency_links
-        kwargs['zip_safe'] = False
-        cmdclass['install_data'] = MyInstallData
-
-    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 = cmdclass,
-                 classifiers = classifiers,
-                 **kwargs
-                 )
-
-if __name__ == '__main__' :
-    install()
+setup(
+    name=distname,
+    version=version,
+    license=license,
+    description=description,
+    long_description=long_description,
+    author=author,
+    author_email=author_email,
+    url=web,
+    classifiers=classifiers,
+    packages=find_packages(exclude=['test']),
+    install_requires=install_requires,
+    include_package_data=True,
+    entry_points={
+        'cubicweb.cubes': [
+            'saem_ref=cubicweb_saem_ref',
+        ],
+    },
+    zip_safe=False,
+)
diff --git a/tox.ini b/tox.ini
--- a/tox.ini
+++ b/tox.ini
@@ -33,10 +33,10 @@ deps =
   sphinx
 commands = sphinx-build -b html -d {envtmpdir}/doctrees .  {envtmpdir}/html
 
 [flake8]
 max-line-length = 100
-exclude = migration,setup.py,uiprops.py,.tox,doc,scripts
+exclude = cubicweb_saem_ref/migration,cubicweb_saem_ref/uiprops.py,.tox,doc,cubicweb_saem_ref/scripts
 ignore = W503
 
 [pytest]
 python_files = *test_*.py


More information about the saem-devel mailing list