[PATCH 1 of 9 Registration cube] [new style] convert cube to new style

Nsukami Patrick ptrck at nskm.xyz
Wed Apr 1 12:50:04 CEST 2020


# HG changeset patch
# User Nsukami Patrick <ptrck at nskm dot xyz>
# Date 1585671815 0
#      Tue Mar 31 16:23:35 2020 +0000
# Node ID 60b867364238ef386f79cd6c63f3538bc569ccbb
# Parent  d64174483a79130418e3f59d46c8868774888c18
[new style] convert cube to new style

- update setup.py, MANIFEST.in & tox.ini
- move files to cube folder

diff --git a/MANIFEST.in b/MANIFEST.in
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,5 +1,11 @@
+include README
 include *.py
-
-recursive-include data external_resources *.gif *.png *.css *.ico *.js *.ttf
-recursive-include i18n *.po
-recursive-include migration *.py
+include */*.py
+recursive-include cubicweb_registration *.py
+recursive-include cubicweb_registration/data *.gif *.png *.ico *.css *.js
+recursive-include cubicweb_registration/i18n *.po
+recursive-include cubicweb_registration/wdoc *
+recursive-include test/data bootstrap_cubes *.py
+include *.ini
+prune debian
+prune cubicweb-registration.spec
diff --git a/__init__.py b/cubicweb_registration/__init__.py
rename from __init__.py
rename to cubicweb_registration/__init__.py
diff --git a/__pkginfo__.py b/cubicweb_registration/__pkginfo__.py
rename from __pkginfo__.py
rename to cubicweb_registration/__pkginfo__.py
--- a/__pkginfo__.py
+++ b/cubicweb_registration/__pkginfo__.py
@@ -1,56 +1,26 @@
-# pylint: disable-msg=W0622
+# pylint: disable=W0622
 """cubicweb-registration application packaging information"""
 
-from os import listdir as _listdir
-from os.path import join, isdir
-from glob import glob
 
-modname = 'registration'
+modname = 'cubicweb_registration'
 distname = 'cubicweb-registration'
 
 numversion = (0, 7, 0)
 version = '.'.join(str(num) for num in numversion)
 
 license = 'LGPL'
-description = 'public registration component for the CubicWeb framework'
 author = 'LOGILAB S.A. (Paris, FRANCE)'
 author_email = 'contact at logilab.fr'
+description = 'public registration component for the CubicWeb framework'
 web = 'http://www.cubicweb.org/project/%s' % distname
+
+__depends__ = {'cubicweb': '>= 3.26.0', 'cubicweb-forgotpwd': None, 'Pillow': None, 'pycrypto': None}
+__recommends__ = {}
+
 classifiers = [
     'Environment :: Web Environment',
     'Framework :: CubicWeb',
-    'Programming Language :: Python',
+    'Programming Language :: Python :: 3',
     'Programming Language :: JavaScript',
 ]
 
-__depends__ = {
-    'cubicweb': '>= 3.19.0',
-    'cubicweb-forgotpwd': None,
-    'Pillow': None,
-    'pycrypto': None,
-}
-
-# packaging ###
-
-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']],
-]
-
-# check for possible extended cube layout
-for dirname in ('entities', 'views', 'sobjects', 'hooks', 'schema', 'data',
-                'i18n', 'migration', 'wdoc'):
-    if isdir(dirname):
-        data_files.append([join(THIS_CUBE_DIR, dirname), listdir(dirname)])
-# Note: here, you'll need to add subdirectories if you want
-# them to be included in the debian package
diff --git a/i18n/en.po b/cubicweb_registration/i18n/en.po
rename from i18n/en.po
rename to cubicweb_registration/i18n/en.po
diff --git a/i18n/fr.po b/cubicweb_registration/i18n/fr.po
rename from i18n/fr.po
rename to cubicweb_registration/i18n/fr.po
diff --git a/migration/0.7.0_Any.py b/cubicweb_registration/migration/0.7.0_Any.py
rename from migration/0.7.0_Any.py
rename to cubicweb_registration/migration/0.7.0_Any.py
diff --git a/migration/postcreate.py b/cubicweb_registration/migration/postcreate.py
rename from migration/postcreate.py
rename to cubicweb_registration/migration/postcreate.py
diff --git a/site_cubicweb.py b/cubicweb_registration/site_cubicweb.py
rename from site_cubicweb.py
rename to cubicweb_registration/site_cubicweb.py
diff --git a/views.py b/cubicweb_registration/views.py
rename from views.py
rename to cubicweb_registration/views.py
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -1,9 +1,11 @@
 #!/usr/bin/env python
 # 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 a cubicweb-registration.
+#
 # 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)
@@ -14,190 +16,67 @@
 # 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_registration setup module using data from
+cubicweb_registration/__pkginfo__.py file
 """
-__docformat__ = "restructuredtext en"
-
-import os
-import sys
-import shutil
-from os.path import isdir, exists, join
-
-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 = open('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__)
+
+# 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_registration', '__pkginfo__.py')
+__pkginfo__ = {}
+with open(pkginfo) as f:
+    exec(f.read(), __pkginfo__)
 
-def export(from_dir, to_dir,
-           blacklist=BASE_BLACKLIST,
-           ignore_ext=IGNORED_EXTENSIONS,
-           verbose=True):
-    try:
-        os.mkdir(to_dir)
-    except OSError as ex:
-        # file exists ?
-        import errno
-        if ex.errno != errno.EEXIST:
-            raise
-    else:
-        if verbose:
-            print('created %s directory' % to_dir)
-    for dirpath, dirnames, filenames in os.walk(from_dir):
-        for norecurs in blacklist:
-            try:
-                dirnames.remove(norecurs)
-            except ValueError:
-                pass
-            else:
-                if verbose:
-                    print('not recursing in %s' % join(dirpath, norecurs))
-        for dirname in dirnames:
-            src = join(dirpath, dirname)
-            dest = to_dir + src[len(from_dir):]
-            if not exists(dest):
-                if verbose:
-                    print('creating %s directory' % dest)
-                os.mkdir(dest)
-        for filename in filenames:
-            # don't include binary files
-            src = join(dirpath, filename)
-            dest = to_dir + src[len(from_dir):]
-            if filename[-4:] in ignore_ext:
-                continue
-            if filename[-1] == '~':
-                continue
-            if exists(dest):
-                os.remove(dest)
-            if verbose:
-                print('copying %s to %s' % (src, dest))
-            shutil.copy2(src, dest)
+# 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': [
+            'registration=cubicweb_registration',
+        ],
+    },
+    zip_safe=False,
+)
diff --git a/tox.ini b/tox.ini
--- a/tox.ini
+++ b/tox.ini
@@ -1,26 +1,30 @@
 [tox]
-envlist = py27-{release,dev},flake8
+envlist = py3,flake8,check-manifest
 
 [testenv]
-sitepackages = true
 deps =
   pytest
-  dev: hg+http://hg.logilab.org/master/cubicweb@3.24#egg=cubicweb
-commands = {envpython} -m pytest {posargs:{toxinidir}/test}
+commands =
+  {envpython} -m pytest {posargs:test}
 
 [testenv:flake8]
+basepython = python3
 skip_install = true
-whitelist_externals =
-  flake8
 deps =
   flake8
-commands = flake8 {posargs:{toxinidir}}
+commands = flake8
+
+[testenv:check-manifest]
+skip_install = true
+deps =
+  check-manifest
+commands =
+  {envpython} -m check_manifest {toxinidir}
 
 [flake8]
+ignore = W503
 max-line-length = 100
-exclude = migration,setup.py,uiprops.py,.tox,doc,scripts
-ignore = W503
+exclude = cubicweb_registration/migration/*,test/data/*,.tox/*
 
 [pytest]
 python_files = *test_*.py
-




More information about the cubicweb-devel mailing list