Commit 4dc47830 authored by Katia Saurfelt's avatar Katia Saurfelt
Browse files

New style: convert cube to new layout

* move file to cube folder
* update MANIFEST.in and setup.py
* update dependencies to cubicweb > 3.24.0
* fix flake8 on cubicweb_ckeditor/__init__.py and cubicweb_ckeditor/__pkginfo__.py
parent 8e1e3f2260a4
include README.rst
include *.py
include */*.py
recursive-include data *.gif *.png *.ico *.css *.js
recursive-include i18n *.po
recursive-include wdoc *
include README.rst
recursive-include cubicweb_ckeditor *.py
recursive-include cubicweb_ckeditor/data *.gif *.png *.ico *.css *.js
recursive-include cubicweb_ckeditor/i18n *.po
recursive-include cubicweb_ckeditor/wdoc *
recursive-include test/data bootstrap_cubes *.py
prune debian
exclude *.spec
......@@ -35,6 +35,7 @@ def fckeditor_config(self):
self.html_headers.define_var('ckconfigpath',
self.data_url('ckeditor-config.js'))
@monkeypatch(WebConfiguration)
def fckeditor_installed(self):
if self.uiprops is None:
......
# pylint: disable=W0622
"""cubicweb-ckeditor application packaging information"""
from os import listdir as _listdir
from os.path import join, isdir
from glob import glob
modname = 'ckeditor'
distname = 'cubicweb-ckeditor'
......@@ -13,7 +17,9 @@ author_email = 'contact@logilab.fr'
description = 'WYSIWYG js editor with ckeditor'
web = 'http://www.cubicweb.org/project/%s' % distname
__depends__ = {'cubicweb': '>= 3.22.2', 'six': '>= 1.4.0'}
__depends__ = {
'cubicweb': '>= 3.24.0',
'six': '>= 1.4.0'}
__recommends__ = {}
classifiers = [
......@@ -21,11 +27,8 @@ classifiers = [
'Framework :: CubicWeb',
'Programming Language :: Python',
'Programming Language :: JavaScript',
]
]
from os import listdir as _listdir
from os.path import join, isdir
from glob import glob
THIS_CUBE_DIR = join('share', 'cubicweb', 'cubes', modname)
......@@ -36,10 +39,11 @@ def listdir(dirpath):
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 dname in ('entities', 'views', 'sobjects', 'hooks', 'schema', 'data',
'wdoc', 'i18n', 'migration'):
......
......@@ -11,7 +11,7 @@ X-Python-Version: >= 2.6
Package: cubicweb-ckeditor
Architecture: all
Depends:
cubicweb-common (>= 3.22.2),
cubicweb-common (>= 3.24.0),
python-six (>= 1.4.0),
${python:Depends},
${misc:Depends},
......
......@@ -18,189 +18,76 @@
#
# 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
"""cubicweb_rememberme setup module using data from
cubicweb_rememberme/__pkginfo__.py file
"""
__docformat__ = "restructuredtext en"
import os
import sys
import shutil
from os.path import exists, join, walk
from os.path import join, dirname
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
from setuptools import find_packages, setup
from setuptools.command.sdist import sdist
# import required features
from __pkginfo__ import modname, version, license, description, web, \
author, author_email, classifiers
if exists('README.rst'):
long_description = open('README.rst').read()
else:
long_description = ''
# 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.items()]
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', '~')
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 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)
class MyInstallLib(install_lib.install_lib):
"""extend install_lib command to handle package __init__.py and
include_dirs variable if necessary
"""
class jsdist(sdist):
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:
# only if easy_install available
import setuptools.command.easy_install # noqa
# 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()
self.spawn(["npm", "install"])
self.spawn(["npm", "run", "build"])
sdist.run(self)
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_ckeditor", "__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.rst")) 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()
]
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": [
"ckeditor=cubicweb_ckeditor",
],
},
zip_safe=False,
cmdclass={"jsdist": jsdist},
)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment