bugfixes for recipe gw_package. Added also buildout support

groundwork/plugins/gw_plugins_info.py

@@ -77,23 +77,23 @@ def deactivate(self):
 
     def _list_plugins(self):
         for key, plugin in self.app.plugins.classes.get().items():
-            print("*" * (len(plugin["name"]) + 4))
-            print("* %s *" % plugin["name"])
-            print("*" * (len(plugin["name"]) + 4))
+            print("*" * (len(plugin.name) + 4))
+            print("* %s *" % plugin.name)
+            print("*" * (len(plugin.name) + 4))
             print("")
-            print("  Package: %s (%s)" % (plugin["distribution"]["key"], plugin["distribution"]["version"]))
-            print("  Path: %s" % plugin["path"])
+            print("  Package: %s (%s)" % (plugin.distribution["key"], plugin.distribution["version"]))
+            print("  Path: %s" % plugin.distribution["path"])
 
-            if plugin["class"] is not None:
+            if plugin.clazz is not None:
                 print("\n  Description:")
-                print(plugin["class"].__doc__)
+                print(plugin.clazz.__doc__)
 
                 print("\n  MRO:")
-                for mro in plugin["class"].__mro__:
+                for mro in plugin.clazz.__mro__:
                     print("  ", mro.__name__)
 
             # if "instance" in plugin.keys() and plugin["instance"] is not None:
-            plugin_instance = self.app.plugins.get(plugin["name"])
+            plugin_instance = self.app.plugins.get(plugin.name)
             if plugin_instance is not None:
                 print("\n  Functions:")
                 for instance_cls in inspect.getmro(plugin_instance.__class__):

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/.gitignore

@@ -57,4 +57,13 @@ docs/_build/
 docs/_themes
 
 # PyBuilder
-target/
+target/
+
+# Buildout folder
+# These folders are created during buildout configuration process.
+src/
+bin/
+
+
+# IDEA IDEs
+.idea/

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/README

@@ -1,6 +1,6 @@
 Installation
 ============
 
-Inside XY run::
+Inside {{cookiecutter.project_slug}} run::
 
     python setup.py develop

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/bootstrap.py

@@ -0,0 +1,189 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os
+import shutil
+import sys
+import tempfile
+
+from optparse import OptionParser
+
+tmpeggs = tempfile.mkdtemp()
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --find-links to point to local resources, you can keep
+this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", help="use a specific zc.buildout version")
+
+parser.add_option("-t", "--accept-buildout-test-releases",
+                  dest='accept_buildout_test_releases',
+                  action="store_true", default=False,
+                  help=("Normally, if you do not specify a --version, the "
+                        "bootstrap script and buildout gets the newest "
+                        "*final* versions of zc.buildout and its recipes and "
+                        "extensions for you.  If you use this flag, "
+                        "bootstrap and buildout will get the newest releases "
+                        "even if they are alphas or betas."))
+parser.add_option("-c", "--config-file",
+                  help=("Specify the path to the buildout configuration "
+                        "file to be used."))
+parser.add_option("-f", "--find-links",
+                  help=("Specify a URL to search for buildout releases"))
+parser.add_option("--allow-site-packages",
+                  action="store_true", default=False,
+                  help=("Let bootstrap.py use existing site packages"))
+parser.add_option("--setuptools-version",
+                  help="use a specific setuptools version")
+
+
+options, args = parser.parse_args()
+
+######################################################################
+# load/install setuptools
+
+try:
+    if options.allow_site_packages:
+        import setuptools
+        import pkg_resources
+    from urllib.request import urlopen
+except ImportError:
+    from urllib2 import urlopen
+
+ez = {}
+exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
+
+if not options.allow_site_packages:
+    # ez_setup imports site, which adds site packages
+    # this will remove them from the path to ensure that incompatible versions
+    # of setuptools are not in the path
+    import site
+    # inside a virtualenv, there is no 'getsitepackages'.
+    # We can't remove these reliably
+    if hasattr(site, 'getsitepackages'):
+        for sitepackage_path in site.getsitepackages():
+            sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
+
+setup_args = dict(to_dir=tmpeggs, download_delay=0)
+
+if options.setuptools_version is not None:
+    setup_args['version'] = options.setuptools_version
+
+ez['use_setuptools'](**setup_args)
+import setuptools
+import pkg_resources
+
+# This does not (always?) update the default working set.  We will
+# do it.
+for path in sys.path:
+    if path not in pkg_resources.working_set.entries:
+        pkg_resources.working_set.add_entry(path)
+
+######################################################################
+# Install buildout
+
+ws = pkg_resources.working_set
+
+cmd = [sys.executable, '-c',
+       'from setuptools.command.easy_install import main; main()',
+       '-mZqNxd', tmpeggs]
+
+find_links = os.environ.get(
+    'bootstrap-testing-find-links',
+    options.find_links or
+    ('http://downloads.buildout.org/'
+     if options.accept_buildout_test_releases else None)
+    )
+if find_links:
+    cmd.extend(['-f', find_links])
+
+setuptools_path = ws.find(
+    pkg_resources.Requirement.parse('setuptools')).location
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+    # Figure out the most recent final version of zc.buildout.
+    import setuptools.package_index
+    _final_parts = '*final-', '*final'
+
+    def _final_version(parsed_version):
+        try:
+            return not parsed_version.is_prerelease
+        except AttributeError:
+            # Older setuptools
+            for part in parsed_version:
+                if (part[:1] == '*') and (part not in _final_parts):
+                    return False
+            return True
+
+    index = setuptools.package_index.PackageIndex(
+        search_path=[setuptools_path])
+    if find_links:
+        index.add_find_links((find_links,))
+    req = pkg_resources.Requirement.parse(requirement)
+    if index.obtain(req) is not None:
+        best = []
+        bestv = None
+        for dist in index[req.project_name]:
+            distv = dist.parsed_version
+            if _final_version(distv):
+                if bestv is None or distv > bestv:
+                    best = [dist]
+                    bestv = distv
+                elif distv == bestv:
+                    best.append(dist)
+        if best:
+            best.sort()
+            version = best[-1].version
+if version:
+    requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+import subprocess
+if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
+    raise Exception(
+        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
+
+######################################################################
+# Import and run buildout
+
+ws.add_entry(tmpeggs)
+ws.require(requirement)
+import zc.buildout.buildout
+
+if not [a for a in args if '=' not in a]:
+    args.append('bootstrap')
+
+# if -c was provided, we push it back into args for buildout' main function
+if options.config_file is not None:
+    args[0:0] = ['-c', options.config_file]
+
+zc.buildout.buildout.main(args)
+shutil.rmtree(tmpeggs)

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/buildout.cfg

@@ -0,0 +1,58 @@
+[buildout]
+relative-paths = false
+extends =
+    versions.cfg
+develop = .
+extensions = mr.developer
+sources = sources
+sources-dir = src
+auto-checkout = *
+update-versions-file = versions.cfg
+show-picked-versions = true
+mr.developer-threads = 1
+parts = groundwork
+        buildtool
+# Activate the following part to get node and bower support for javascript support (frontend development)
+# Don't forget to uncomment also the related sections!
+#        node
+#        web
+
+[groundwork]
+# Add all needed eggs here. Dependecies defined in their setup.py get automatically downloaded.
+recipe = zc.recipe.egg
+eggs = groundwork
+#       groundwork-database
+#       groundwork-web
+#       groundwork-utilities
+
+dependent-scripts = true
+interpreter = py
+
+[buildtool]
+# https://github.com/cosent/cosent.buildtools
+# Installs a tool, which helps to deploy/tag/release new version or check all development repositories for updates.
+recipe = zc.recipe.egg
+eggs = cosent.buildtools
+dependent-scripts = true
+interpreter = py
+scripts = buildtool
+
+# [sources]
+# Define git repositories here to get the source code instead of an egg.
+# Very useful if you need to develop on different package in parallel
+# Destination is /src.
+# E.g. /src/groundwork (with full git support to puul/push updates)
+# groundwork = git https://github.com/useblocks/groundwork
+
+# [node]
+# https://pypi.python.org/pypi/gp.recipe.node
+# recipe = gp.recipe.node
+#url = http://nodejs.org/dist/v0.10.33/node-v0.10.33.tar.gz
+# npms = bower
+# scripts = bower
+
+# [web]
+# https://pypi.python.org/pypi/bowerrecipe/0.2
+# recipe = bowerrecipe
+# packages = jquery#1.8.3 normalize-css
+# executable = ${buildout:bin-directory}/bower

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/versions.cfg

@@ -0,0 +1 @@
+[versions]

groundwork/recipes/gw_package/{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/applications/{{cookiecutter.project_app}}.py

@@ -6,3 +6,7 @@ def start_app():
     app = App([os.path.join(os.path.dirname(__file__), "configuration.py")])
     app.plugins.activate(["{{cookiecutter.project_plugin}}", "GwPluginsInfo"])
     app.commands.start_cli()
+
+
+if "main" in __name__:
+    start_app()