diff --git a/README b/README new file mode 100644 index 0000000000000000000000000000000000000000..e96428b232ebc70545146719483faa8f5edd32ef_UkVBRE1F --- /dev/null +++ b/README @@ -0,0 +1,28 @@ +Summary +------- + +The `comment` cube provides threadable comments feature. + +Usage +----- + +This cube creates a new entity type called `Comment` which could basically be +read by every body but only added by application's users. +It also defines a relation `comments` which provides the ability to add a +`Comment` which `comments` a `Comment`. + +To use this cube, you want to add the relation `comments` on the entity type +you want to be able to comment. For instance, let's say your cube defines a +schema for a blog. You want all the blog entries to be commentable. +Here is how to define it in your schema: + +.. sourcecode:: python + + from yams.buildobjs import RelationDefinition + class comments(RelationDefinition): + subject = 'Comment' + object = 'BlogEntry' + cardinality = '1*' + +Once this relation is defined, you can post comments and view threadable +comments automatically on blog entry's primary view. diff --git a/__pkginfo__.py b/__pkginfo__.py index ea34a0ba9f268fa056f56d49a83623d1c816b8f9_X19wa2dpbmZvX18ucHk=..e96428b232ebc70545146719483faa8f5edd32ef_X19wa2dpbmZvX18ucHk= 100644 --- a/__pkginfo__.py +++ b/__pkginfo__.py @@ -8,10 +8,8 @@ version = '.'.join(str(num) for num in numversion) license = 'LGPL' -copyright = '''Copyright (c) 2003-2010 LOGILAB S.A. (Paris, FRANCE). -http://www.logilab.fr/ -- mailto:contact@logilab.fr''' author = "Logilab" author_email = "contact@logilab.fr" web = 'http://www.cubicweb.org/project/%s' % distname @@ -13,12 +11,7 @@ author = "Logilab" author_email = "contact@logilab.fr" web = 'http://www.cubicweb.org/project/%s' % distname -short_desc = "commenting system for the CubicWeb framework" -long_desc = """\ -Summary -------- - -The `comment` cube provides threadable comments feature. +description = "commenting system for the CubicWeb framework" @@ -24,9 +17,2 @@ -Usage ------ - -This cube creates a new entity type called `Comment` which could basically be -read by every body but only added by application's users. -It also defines a relation `comments` which provides the ability to add a -`Comment` which `comments` a `Comment`. @@ -32,8 +18,9 @@ -To use this cube, you want to add the relation `comments` on the entity type -you want to be able to comment. For instance, let's say your cube defines a -schema for a blog. You want all the blog entries to be commentable. -Here is how to define it in your schema: - -.. sourcecode:: python +__depends__ = {'cubicweb': '>= 3.6.0'} +classifiers = [ + 'Environment :: Web Environment', + 'Framework :: CubicWeb', + 'Programming Language :: Python', + 'Programming Language :: JavaScript', +] @@ -39,13 +26,4 @@ - from yams.buildobjs import RelationDefinition - class comments(RelationDefinition): - subject = 'Comment' - object = 'BlogEntry' - cardinality = '1*' - -Once this relation is defined, you can post comments and view threadable -comments automatically on blog entry's primary view. -""" from os import listdir from os.path import join @@ -67,16 +45,3 @@ except OSError: # we are in an installed directory pass - - -cube_eid = 20316 -# used packages -__depends_cubes__ = {} -__depends__ = {'cubicweb': '>= 3.6.0'} -__use__ = tuple(__depends_cubes__) -classifiers = [ - 'Environment :: Web Environment', - 'Framework :: CubicWeb', - 'Programming Language :: Python', - 'Programming Language :: JavaScript', -] diff --git a/setup.py b/setup.py index ea34a0ba9f268fa056f56d49a83623d1c816b8f9_c2V0dXAucHk=..e96428b232ebc70545146719483faa8f5edd32ef_c2V0dXAucHk= 100644 --- a/setup.py +++ b/setup.py @@ -1,22 +1,13 @@ #!/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 @@ -19,9 +10,6 @@ import os import sys import shutil -from distutils.core import setup -from distutils import command -from distutils.command import install_lib from os.path import isdir, exists, join, walk @@ -26,3 +14,16 @@ 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 + + +sys.modules.pop('__pkginfo__', None) # import required features @@ -28,4 +29,4 @@ # 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 @@ -30,19 +31,14 @@ web, author, author_email # import optional features -try: - from __pkginfo__ import distname -except ImportError: - distname = distname -try: - from __pkginfo__ import scripts -except ImportError: - scripts = [] -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', '~') @@ -48,6 +44,16 @@ -BASE_BLACKLIST = ('CVS', 'debian', 'dist', 'build', '__buildlog') -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): @@ -52,6 +58,6 @@ def ensure_scripts(linux_scripts): - """creates the proper script names required for each platform + """Creates the proper script names required for each platform (taken from 4Suite) """ from distutils import util @@ -61,4 +67,18 @@ 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 @@ -64,4 +84,58 @@ +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""" @@ -65,18 +139,32 @@ 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, - scripts=ensure_scripts(scripts), - 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()