[PATCH 1 of 8 Invoice cube] New style: convert cube to new layout

Nsukami Patrick ndkpatt at gmail.com
Wed Jun 12 14:55:23 CEST 2019


# HG changeset patch
# User Nsukami Patrick <ndkpatt at gmail dot com>
# Date 1560343899 0
#      Wed Jun 12 12:51:39 2019 +0000
# Node ID 8cfd7544b1be6f21e4adde473f210b6287357179
# Parent  15075f6178a66333f4f08b2c2d7c8ece817b4a04
New style: convert cube to new layout

* move files to cube folder
* update setup.py, MANIFEST.in, __pkginfo__.py
* add tox.ini file
* use unittest from std lib

diff --git a/MANIFEST.in b/MANIFEST.in
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,6 +1,10 @@
 include *.py
-include ChangeLog
-
-recursive-include data external_resources *.gif *.png *.css *.ico *.js
-recursive-include i18n *.pot *.po
-recursive-include migration *.sql *.py
+include */*.py
+recursive-include cubicweb_invoice *.py
+recursive-include cubicweb_invoice/data *.gif *.png *.ico *.css *.js
+recursive-include cubicweb_invoice/i18n *.po
+recursive-include cubicweb_invoice/wdoc *
+recursive-include test/data bootstrap_cubes *.py
+include *.ini
+prune debian
+prune cubicweb-invoice.spec
diff --git a/__init__.py b/cubicweb_invoice/__init__.py
rename from __init__.py
rename to cubicweb_invoice/__init__.py
diff --git a/__pkginfo__.py b/cubicweb_invoice/__pkginfo__.py
rename from __pkginfo__.py
rename to cubicweb_invoice/__pkginfo__.py
--- a/__pkginfo__.py
+++ b/cubicweb_invoice/__pkginfo__.py
@@ -1,8 +1,9 @@
-# pylint: disable-msg=W0622
+# pylint: disable=W0622
 """cubicweb-invoice application packaging information"""
 
-modname = 'invoice'
-distname = 'cubicweb-%s' % modname
+
+modname = 'cubicweb_invoice'
+distname = 'cubicweb-invoice'
 
 numversion = (0, 8, 0)
 version = '.'.join(str(num) for num in numversion)
@@ -12,38 +13,14 @@
 author_email = 'contact at logilab.fr'
 description = 'invoice component for the CubicWeb framework'
 web = 'http://www.cubicweb.org/project/%s' % distname
+
+__depends__ = {'cubicweb': '>= 3.24.0'}
+__recommends__ = {}
+
 classifiers = [
     'Environment :: Web Environment',
     'Framework :: CubicWeb',
-    'Programming Language :: Python',
+    'Programming Language :: Python :: 3',
     'Programming Language :: JavaScript',
-    ]
-
-__depends__ = {'cubicweb': '>= 3.9.0'}
-
-
-# packaging ###
-
-from os import listdir as _listdir
-from os.path import join, isdir
-from glob import glob
-
-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/entities.py b/cubicweb_invoice/entities.py
rename from entities.py
rename to cubicweb_invoice/entities.py
diff --git a/i18n/en.po b/cubicweb_invoice/i18n/en.po
rename from i18n/en.po
rename to cubicweb_invoice/i18n/en.po
diff --git a/i18n/es.po b/cubicweb_invoice/i18n/es.po
rename from i18n/es.po
rename to cubicweb_invoice/i18n/es.po
diff --git a/i18n/fr.po b/cubicweb_invoice/i18n/fr.po
rename from i18n/fr.po
rename to cubicweb_invoice/i18n/fr.po
diff --git a/migration/0.2.0_Any.py b/cubicweb_invoice/migration/0.2.0_Any.py
rename from migration/0.2.0_Any.py
rename to cubicweb_invoice/migration/0.2.0_Any.py
diff --git a/migration/0.3.1_Any.py b/cubicweb_invoice/migration/0.3.1_Any.py
rename from migration/0.3.1_Any.py
rename to cubicweb_invoice/migration/0.3.1_Any.py
diff --git a/migration/0.8.0_Any.py b/cubicweb_invoice/migration/0.8.0_Any.py
rename from migration/0.8.0_Any.py
rename to cubicweb_invoice/migration/0.8.0_Any.py
diff --git a/migration/postcreate.py b/cubicweb_invoice/migration/postcreate.py
rename from migration/postcreate.py
rename to cubicweb_invoice/migration/postcreate.py
diff --git a/schema.py b/cubicweb_invoice/schema.py
rename from schema.py
rename to cubicweb_invoice/schema.py
--- a/schema.py
+++ b/cubicweb_invoice/schema.py
@@ -1,7 +1,7 @@
 from yams.buildobjs import EntityType, SubjectRelation, String, Date, Float
 from cubicweb.schema import WorkflowableEntityType
+from cubicweb import _
 
-_ = unicode
 
 class Invoice(WorkflowableEntityType):
     num = String(required=True, fulltextindexed=True, indexed=True,
diff --git a/sobjects.py b/cubicweb_invoice/sobjects.py
rename from sobjects.py
rename to cubicweb_invoice/sobjects.py
diff --git a/views.py b/cubicweb_invoice/views.py
rename from views.py
rename to cubicweb_invoice/views.py
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -1,164 +1,82 @@
 #!/usr/bin/env python
-# pylint: disable-msg=W0404,W0622,W0704,W0613,W0152
-# copyright 2003-2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
+#
+# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 # contact http://www.logilab.fr/ -- mailto:contact at logilab.fr
-
-__docformat__ = "restructuredtext en"
-
-import os
-import sys
-import shutil
-from os.path import isdir, exists, join, walk
-
-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
-
+#
+# This file is part of a cubicweb-invoice.
+#
+# 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.
+#
+# 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/>.
+"""cubicweb_invoice setup module using data from
+cubicweb_invoice/__pkginfo__.py file
+"""
 
-sys.modules.pop('__pkginfo__', None)
-# import required features
-from __pkginfo__ import modname, version, license, description, \
-     web, author, author_email
-# import optional features
-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')
+from os.path import join, dirname
 
-IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
-
-if exists('README'):
-    long_description = open('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 = []
+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 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
+# 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_invoice', '__pkginfo__.py')
+__pkginfo__ = {}
+with open(pkginfo) as f:
+    exec(f.read(), __pkginfo__)
 
-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)
+# 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)
-
-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')
-    if USE_SETUPTOOLS and install_requires:
-        kwargs['install_requires'] = install_requires
-        kwargs['dependency_links'] = dependency_links
-    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()
+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': [
+            'invoice=cubicweb_invoice',
+        ],
+    },
+    zip_safe=False,
+)
diff --git a/test/test_invoice.py b/test/test_invoice.py
--- a/test/test_invoice.py
+++ b/test/test_invoice.py
@@ -1,4 +1,4 @@
-from logilab.common.testlib import unittest_main
+import unittest
 from cubicweb.devtools.testlib import AutomaticWebTest
 
 class AutomaticWebTest(AutomaticWebTest):
@@ -10,4 +10,4 @@
         return ()
 
 if __name__ == '__main__':
-    unittest_main()
+    unittest.main()
diff --git a/tox.ini b/tox.ini
new file mode 100644
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,25 @@
+[tox]
+envlist = py3,flake8,check-manifest
+
+[testenv]
+deps =
+  pytest
+commands =
+  {envpython} -m pytest {posargs:test}
+
+[testenv:flake8]
+basepython = python3
+skip_install = true
+deps =
+  flake8
+commands = flake8
+
+[testenv:check-manifest]
+skip_install = true
+deps =
+  check-manifest
+commands =
+  {envpython} -m check_manifest {toxinidir}
+
+[flake8]
+exclude = cubicweb_invoice/migration/*,test/data/*,.tox/*



More information about the cubicweb-devel mailing list