Add a paster template.

author: Chris McDonough <chrism@agendaless.com> 2008-07-19 02:14:10 +0000
committer: Chris McDonough <chrism@agendaless.com> 2008-07-19 02:14:10 +0000
commit: b5c35e4303f6af41cec2a81169b6722c42359406 (patch)
tree: dc8da79f82e43f6941640c2b5dd4c78d239ad2a5
parent: c42a5844612d8033016d3a4b9c0726ae5bde12c9 (diff)
download: pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.tar.gz
pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.tar.bz2
pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.zip
13 files changed, 400 insertions, 0 deletions
diff --git a/repoze/bfg/paster.py b/repoze/bfg/paster.py
new file mode 100644
index 000000000..8a1ab028d
--- /dev/null
+++ b/repoze/bfg/paster.py
@@ -0,0 +1,21 @@
+from paste.script.templates import Template, var
+from paste.util.template import paste_script_template_renderer
+
+vars = [
+    var('version', '0.1'),
+    var('description', 'One-line description of the package'),
+#    var('long_description', 'Multi-line description (in reST)'),
+#    var('keywords', 'Space-separated keywords/tags'),
+#    var('author', 'Author name'),
+#    var('author_email', 'Author email'),
+#    var('url', 'URL of homepage'),
+#    var('license_name', 'License name'),
+    var('zip_safe', 'True/False: if the package can be distributed as a .zip file',
+        default=False),
+]
+
+class BFGProjectTemplate(Template):
+    _template_dir = 'paster_template'
+    summary = 'repoze.bfg starter project'
+    vars = vars
+    template_renderer = staticmethod(paste_script_template_renderer)
diff --git a/repoze/bfg/paster_template/+package+/__init__.py b/repoze/bfg/paster_template/+package+/__init__.py
new file mode 100644
index 000000000..cbdfd3ac6
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/__init__.py
@@ -0,0 +1,2 @@
+# A package
+
diff --git a/repoze/bfg/paster_template/+package+/configure.zcml b/repoze/bfg/paster_template/+package+/configure.zcml
new file mode 100644
index 000000000..174b27354
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/configure.zcml
@@ -0,0 +1,13 @@
+<configure xmlns="http://namespaces.zope.org/zope"
+	   xmlns:bfg="http://namespaces.repoze.org/bfg"
+	   i18n_domain="repoze.bfg">
+
+  <!-- this must be included for the view declarations to work -->
+  <include package="repoze.bfg" />
+
+  <bfg:view
+     for=".models.IMyModel"
+     view=".views.my_view"
+     />
+
+</configure>
diff --git a/repoze/bfg/paster_template/+package+/models.py b/repoze/bfg/paster_template/+package+/models.py
new file mode 100644
index 000000000..5861c738c
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/models.py
@@ -0,0 +1,13 @@
+from zope.interface import Interface
+from zope.interface import implements
+
+class IMyModel(Interface):
+    pass
+
+class MyModel(object):
+    implements(IMyModel)
+    pass
+
+def get_root(environ):
+    root = MyModel()
+    return root
diff --git a/repoze/bfg/paster_template/+package+/run.py_tmpl b/repoze/bfg/paster_template/+package+/run.py_tmpl
new file mode 100644
index 000000000..895782a3e
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/run.py_tmpl
@@ -0,0 +1,5 @@
+def make_app(global_config):
+    from {{project}}.models import get_root
+    import {{project}}
+    from repoze.bfg.router import make_app
+    return make_app(get_root, {{project}})
diff --git a/repoze/bfg/paster_template/+package+/templates/mytemplate.pt b/repoze/bfg/paster_template/+package+/templates/mytemplate.pt
new file mode 100644
index 000000000..becc5e9ec
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/templates/mytemplate.pt
@@ -0,0 +1,7 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+     xmlns:tal="http://xml.zope.org/namespaces/tal">
+<head></head>
+<body>
+  <h1>${greeting}</h1>
+</body>
+</html>
diff --git a/repoze/bfg/paster_template/+package+/views.py b/repoze/bfg/paster_template/+package+/views.py
new file mode 100644
index 000000000..54f20b83d
--- /dev/null
+++ b/repoze/bfg/paster_template/+package+/views.py
@@ -0,0 +1,5 @@
+from repoze.bfg.template import render_transform_to_response
+
+def my_view(context, request):
+    return render_transform_to_response('templates/mymtemplate.pt',
+                                        greeting = 'hello world')
diff --git a/repoze/bfg/paster_template/CHANGES.txt_tmpl b/repoze/bfg/paster_template/CHANGES.txt_tmpl
new file mode 100644
index 000000000..1544cf53b
--- /dev/null
+++ b/repoze/bfg/paster_template/CHANGES.txt_tmpl
@@ -0,0 +1,3 @@
+0.1
+
+  Initial version
diff --git a/repoze/bfg/paster_template/README.txt_tmpl b/repoze/bfg/paster_template/README.txt_tmpl
new file mode 100644
index 000000000..0ddebfc3e
--- /dev/null
+++ b/repoze/bfg/paster_template/README.txt_tmpl
@@ -0,0 +1,4 @@
+{{project}} README
+
+
+
diff --git a/repoze/bfg/paster_template/ez_setup.py b/repoze/bfg/paster_template/ez_setup.py
new file mode 100644
index 000000000..89cf056d9
--- /dev/null
+++ b/repoze/bfg/paster_template/ez_setup.py
@@ -0,0 +1,272 @@
+#!python
+"""Bootstrap setuptools installation
+
+If you want to use setuptools in your package's setup.py, just include this
+file in the same directory with it, and add this to the top of your setup.py::
+
+    from ez_setup import use_setuptools
+    use_setuptools()
+
+If you want to require a specific version of setuptools, set a download
+mirror, or use an alternate download directory, you can do so by supplying
+the appropriate options to ``use_setuptools()``.
+
+This file can also be run as a script to install or upgrade setuptools.
+"""
+import sys
+DEFAULT_VERSION = "0.6c8"
+DEFAULT_URL     = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3]
+
+md5_data = {
+    'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
+    'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
+    'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
+    'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
+    'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
+    'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
+    'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
+    'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
+    'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
+    'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
+    'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
+    'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
+    'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
+    'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
+    'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
+    'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
+    'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
+    'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
+    'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
+    'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
+    'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
+    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
+    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
+    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
+    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
+    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
+    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
+    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
+    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
+    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
+}
+
+import sys, os
+
+def _validate_md5(egg_name, data):
+    if egg_name in md5_data:
+        from md5 import md5
+        digest = md5(data).hexdigest()
+        if digest != md5_data[egg_name]:
+            print >>sys.stderr, (
+                "md5 validation of %s failed!  (Possible download problem?)"
+                % egg_name
+            )
+            sys.exit(2)
+    return data
+
+
+def use_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    download_delay=15
+):
+    """Automatically find/download setuptools and make it available on sys.path
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end with
+    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
+    it is not already available.  If `download_delay` is specified, it should
+    be the number of seconds that will be paused before initiating a download,
+    should one be required.  If an older version of setuptools is installed,
+    this routine will print a message to ``sys.stderr`` and raise SystemExit in
+    an attempt to abort the calling script.
+    """
+    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
+    def do_download():
+        egg = download_setuptools(version, download_base, to_dir, download_delay)
+        sys.path.insert(0, egg)
+        import setuptools; setuptools.bootstrap_install_from = egg
+    try:
+        import pkg_resources
+    except ImportError:
+        return do_download()       
+    try:
+        pkg_resources.require("setuptools>="+version); return
+    except pkg_resources.VersionConflict, e:
+        if was_imported:
+            print >>sys.stderr, (
+            "The required version of setuptools (>=%s) is not available, and\n"
+            "can't be installed while this script is running. Please install\n"
+            " a more recent version first, using 'easy_install -U setuptools'."
+            "\n\n(Currently using %r)"
+            ) % (version, e.args[0])
+            sys.exit(2)
+        else:
+            del pkg_resources, sys.modules['pkg_resources']    # reload ok
+            return do_download()
+    except pkg_resources.DistributionNotFound:
+        return do_download()
+
+def download_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    delay = 15
+):
+    """Download setuptools from a specified location and return its filename
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end
+    with a '/'). `to_dir` is the directory where the egg will be downloaded.
+    `delay` is the number of seconds to pause before an actual download attempt.
+    """
+    import urllib2, shutil
+    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
+    url = download_base + egg_name
+    saveto = os.path.join(to_dir, egg_name)
+    src = dst = None
+    if not os.path.exists(saveto):  # Avoid repeated downloads
+        try:
+            from distutils import log
+            if delay:
+                log.warn("""
+---------------------------------------------------------------------------
+This script requires setuptools version %s to run (even to display
+help).  I will attempt to download it for you (from
+%s), but
+you may need to enable firewall access for this script first.
+I will start the download in %d seconds.
+
+(Note: if this machine does not have network access, please obtain the file
+
+   %s
+
+and place it in this directory before rerunning this script.)
+---------------------------------------------------------------------------""",
+                    version, download_base, delay, url
+                ); from time import sleep; sleep(delay)
+            log.warn("Downloading %s", url)
+            src = urllib2.urlopen(url)
+            # Read/write all in one block, so we don't create a corrupt file
+            # if the download is interrupted.
+            data = _validate_md5(egg_name, src.read())
+            dst = open(saveto,"wb"); dst.write(data)
+        finally:
+            if src: src.close()
+            if dst: dst.close()
+    return os.path.realpath(saveto)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+def main(argv, version=DEFAULT_VERSION):
+    """Install or upgrade setuptools and EasyInstall"""
+    try:
+        import setuptools
+    except ImportError:
+        egg = None
+        try:
+            egg = download_setuptools(version, delay=0)
+            sys.path.insert(0,egg)
+            from setuptools.command.easy_install import main
+            return main(list(argv)+[egg])   # we're done here
+        finally:
+            if egg and os.path.exists(egg):
+                os.unlink(egg)
+    else:
+        if setuptools.__version__ == '0.0.1':
+            print >>sys.stderr, (
+            "You have an obsolete version of setuptools installed.  Please\n"
+            "remove it from your system entirely before rerunning this script."
+            )
+            sys.exit(2)
+
+    req = "setuptools>="+version
+    import pkg_resources
+    try:
+        pkg_resources.require(req)
+    except pkg_resources.VersionConflict:
+        try:
+            from setuptools.command.easy_install import main
+        except ImportError:
+            from easy_install import main
+        main(list(argv)+[download_setuptools(delay=0)])
+        sys.exit(0) # try to force an exit
+    else:
+        if argv:
+            from setuptools.command.easy_install import main
+            main(argv)
+        else:
+            print "Setuptools version",version,"or greater has been installed."
+            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
+
+def update_md5(filenames):
+    """Update our built-in md5 registry"""
+
+    import re
+    from md5 import md5
+
+    for name in filenames:
+        base = os.path.basename(name)
+        f = open(name,'rb')
+        md5_data[base] = md5(f.read()).hexdigest()
+        f.close()
+
+    data = ["    %r: %r,\n" % it for it in md5_data.items()]
+    data.sort()
+    repl = "".join(data)
+
+    import inspect
+    srcfile = inspect.getsourcefile(sys.modules[__name__])
+    f = open(srcfile, 'rb'); src = f.read(); f.close()
+
+    match = re.search("\nmd5_data = {\n([^}]+)}", src)
+    if not match:
+        print >>sys.stderr, "Internal error!"
+        sys.exit(2)
+
+    src = src[:match.start(1)] + repl + src[match.end(1):]
+    f = open(srcfile,'w')
+    f.write(src)
+    f.close()
+
+
+if __name__=='__main__':
+    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
+        update_md5(sys.argv[2:])
+    else:
+        main(sys.argv[1:])
+
+
+
+
+
diff --git a/repoze/bfg/paster_template/run.py_tmpl b/repoze/bfg/paster_template/run.py_tmpl
new file mode 100644
index 000000000..2d221ead3
--- /dev/null
+++ b/repoze/bfg/paster_template/run.py_tmpl
@@ -0,0 +1,8 @@
+from paste import httpserver
+
+from repoze.bfg import make_app
+from {{project}}.models import get_root
+import {{project}}
+
+app = make_app(get_root, {{project}})
+httpserver.serve(app, host='0.0.0.0', port='5432')
diff --git a/repoze/bfg/paster_template/setup.py_tmpl b/repoze/bfg/paster_template/setup.py_tmpl
new file mode 100644
index 000000000..9e3db8500
--- /dev/null
+++ b/repoze/bfg/paster_template/setup.py_tmpl
@@ -0,0 +1,43 @@
+__version__ = '{{version}}'
+
+import os
+
+from ez_setup import use_setuptools
+use_setuptools()
+
+from setuptools import setup, find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.txt')).read()
+CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
+
+setup(name='{{project}}',
+      version=__version__,
+      description='{{project}}',
+      long_description=README + '\n\n' +  CHANGES,
+      classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python",
+        "Topic :: Internet :: WWW/HTTP",
+        "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+        "Topic :: Internet :: WWW/HTTP :: WSGI",
+        "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+        ],
+      keywords='web wsgi bfg zope',
+      packages=find_packages(),
+      include_package_data=True,
+      zip_safe=False,
+      install_requires=[
+            'repoze.bfg',
+            ],
+      tests_require=[
+            'repoze.bfg',
+            ],
+      test_suite="{{project}}.tests",
+      entry_points = """\
+      [paste.app_factory]
+      {{project}} = {{project}}.run:make_app
+      """
+      )
+
diff --git a/setup.py b/setup.py
index 1a8312131..ed3552a83 100644
--- a/setup.py
+++ b/setup.py
@@ -56,6 +56,7 @@ setup(name='repoze.bfg',
             'Paste',
             'z3c.pt',
             'FormEncode',
+            'PasteScript',
             ],
       tests_require=[
             'zope.interface',
@@ -66,11 +67,14 @@ setup(name='repoze.bfg',
             'Paste',
             'z3c.pt',
             'FormEncode',
+            'PasteScript',
             'Sphinx',
             'docutils',
             ],
       test_suite="repoze.bfg.tests",
       entry_points = """\
+        [paste.paster_create_template]
+        bfg=repoze.bfg.paster:BFGProjectTemplate
       """
       )
author	Chris McDonough <chrism@agendaless.com>	2008-07-19 02:14:10 +0000
committer	Chris McDonough <chrism@agendaless.com>	2008-07-19 02:14:10 +0000
commit	b5c35e4303f6af41cec2a81169b6722c42359406 (patch)
tree	dc8da79f82e43f6941640c2b5dd4c78d239ad2a5
parent	c42a5844612d8033016d3a4b9c0726ae5bde12c9 (diff)
download	pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.tar.gz pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.tar.bz2 pyramid-b5c35e4303f6af41cec2a81169b6722c42359406.zip