{ "info": { "author": "Paul Carduner, Stephan Richter, and hopefully others...", "author_email": "zope-dev@zope.org", "bugtrack_url": null, "classifiers": [], "description": "This package provides the ZBoiler Zope Features.\n\n\nDetailed Documentation\n**********************\n\n\n======================================\nZBoiler - A Quick Way to Boil Projects\n======================================\n\nThe ZBoiler package provides a small script to generate the boilerplate of a\nproject from a simple, high-level feature XML file. An example of such a\nconfiguration file is `sample-project.xml`.\n\n >>> from z3c.boiler import script\n\n >>> def boil(args, showLog=False):\n ... try:\n ... script.main(args)\n ... except SystemExit, err:\n ... print 'Exit Code: %i' % err.code\n ... else:\n ... print 'Error: No proper exit.'\n\nLet's generate the project using the script. We need to specify the\nconfiguration file and a target directory.\n\n >>> import os\n >>> featureFile = os.path.join(\n ... os.path.dirname(script.__file__), 'sample-project.xml')\n\n >>> boil(['-i', featureFile, '-o', buildPath])\n INFO - Creating directory .../z3c.sampleproject\n INFO - Creating file .../z3c.sampleproject/bootstrap.py\n INFO - Creating file .../z3c.sampleproject/setup.py\n INFO - Creating file .../z3c.sampleproject/buildout.cfg\n INFO - Creating directory .../z3c.sampleproject/src\n INFO - Creating directory .../z3c.sampleproject/src/z3c\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/application.zcml\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/browser\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/interfaces.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/index.txt\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/tests\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/test_doc.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/README.txt\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/__init__.py\n INFO - Creating file .../z3c.sampleproject/ZBOILER.txt\n INFO - Build finished\n Exit Code: 0\n\nLet's now have a look at the generated directory:\n\n >>> ls(buildPath)\n z3c.sampleproject/\n ZBOILER.txt\n bootstrap.py\n buildout.cfg\n setup.py\n src/\n z3c/\n __init__.py\n sampleproject/\n README.txt\n __init__.py\n application.zcml\n configure.zcml\n index.txt\n interfaces.py\n message.py\n browser/\n __init__.py\n configure.zcml\n message.pytests/\n __init__.py\n test_doc.py\n\nWhen we try to regenerate the project again, we get a failure, since the\ndirectory already exists:\n\n >>> boil(['-i', featureFile, '-o', buildPath])\n CRITICAL - Failed building package because file .../z3c.sampleproject\n already exists. Use --force to overwrite it.\n Exit Code: 1\n\nWe can, however, force the directory to be overwritten as the message\nmentions:\n\n >>> boil(['-f', '-i', featureFile, '-o', buildPath])\n INFO - Creating directory .../z3c.sampleproject\n INFO - Creating file .../z3c.sampleproject/bootstrap.py\n INFO - Creating file .../z3c.sampleproject/setup.py\n INFO - Creating file .../z3c.sampleproject/buildout.cfg\n INFO - Creating directory .../z3c.sampleproject/src\n INFO - Creating directory .../z3c.sampleproject/src/z3c\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/application.zcml\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/browser\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/interfaces.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/index.txt\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/tests\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/test_doc.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/README.txt\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/__init__.py\n INFO - Creating file .../z3c.sampleproject/ZBOILER.txt\n INFO - Build finished\n Exit Code: 0\n\nIf we want less information, we can simply tell the script to be quiet:\n\n >>> boil(['-q', '-f', '-i', featureFile, '-o', buildPath])\n Exit Code: 0\n\nFatal messages are still displayed:\n\n >>> boil(['-q', '-i', featureFile, '-o', buildPath])\n CRITICAL - Failed building package because file .../z3c.sampleproject\n already exists. Use --force to overwrite it.\n Exit Code: 1\n\nWe can also ask for more information:\n\n >>> boil(['-v', '-f', '-i', featureFile, '-o', buildPath])\n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n DEBUG - Updating \n INFO - Creating directory .../z3c.sampleproject\n INFO - Creating file .../z3c.sampleproject/bootstrap.py\n INFO - Creating file .../z3c.sampleproject/setup.py\n INFO - Creating file .../z3c.sampleproject/buildout.cfg\n INFO - Creating directory .../z3c.sampleproject/src\n INFO - Creating directory .../z3c.sampleproject/src/z3c\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/application.zcml\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/browser\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/browser/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/configure.zcml\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/interfaces.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/index.txt\n INFO - Creating directory .../z3c.sampleproject/src/z3c/sampleproject/tests\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/test_doc.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/tests/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/README.txt\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/message.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/sampleproject/__init__.py\n INFO - Creating file .../z3c.sampleproject/src/z3c/__init__.py\n INFO - Creating file .../z3c.sampleproject/ZBOILER.txt\n INFO - Build finished\n Exit Code: 0\n\nIt is also possible to use a built in project template as a basis for\na new project. To see an available list of built in templates, we use\nthe --list option.\n\n >>> boil(['--list'])\n Available Templates:\n \n zope-project \"Zope 3 Web Application\"\n Includes all the features you would want for a Zope 3 Web Application.\n command-line \"Command Line Program\"\n Includes all the features you would want for a command line program.\n python-package \"Python Package\"\n Just a simple python package with few bells and whistles.\n Exit Code: 0\n\nIf we try to use a template that does not exist, then we are told to\nuse --list:\n\n >>> boil(['-t','foobar'])\n Could not find the template \"foobar\".\n Use --list to see available templates.\n Exit Code: 1\n\n\nLast but not least, we also have some help for the `boil` script:\n\n >>> boil(['-h'])\n Usage: test [options]\n \n Options:\n -h, --help show this help message and exit\n -i FILE, --input-file=FILE\n The file containing the XML definition of the project.\n -t TEMPLATE, --template=TEMPLATE\n A project template. Use --list to see available\n templates\n -l, --list Show a list of available templates for use with\n --template\n -k, --interactive When specified, runs in interactive mode prompting you\n to enter missing values.\n -o DIR, --output-dir=DIR\n The directory where project files should be generated.\n -q, --quiet When specified, no messages are displayed.\n -v, --verbose When specified, debug information is created.\n -f, --force Force the package to be generated even overwriting any\n existing files.\n Exit Code: 0\n\nWhen no arguments are specified, help is also shown:\n\n >>> boil([])\n Usage: test [options]\n ...\n Exit Code: 0\n\n\n=======\nCHANGES\n=======\n\nVersion 0.1.1 (2009-03-27)\n--------------------------\n\n- Initial Release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/z3c.boiler", "keywords": "zope3 project builder boiler", "license": "ZPL 2.1", "maintainer": null, "maintainer_email": null, "name": "z3c.boiler", "package_url": "https://pypi.org/project/z3c.boiler/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/z3c.boiler/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/z3c.boiler" }, "release_url": "https://pypi.org/project/z3c.boiler/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "A utility to help jump start Zope 3 projects", "version": "0.1.1" }, "last_serial": 801999, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "823f1643a9b0bd8ab8cdef01c7d3f3b8", "sha256": "bf1fae832956f3261c7cd5f324fedb802fc52b0a15eac5576a82cd505eb23c96" }, "downloads": -1, "filename": "z3c.boiler-0.1.0.tar.gz", "has_sig": false, "md5_digest": "823f1643a9b0bd8ab8cdef01c7d3f3b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9271, "upload_time": "2009-03-27T12:13:58", "url": "https://files.pythonhosted.org/packages/3b/ad/b5e1b26536b5e3168f916f0c2d178fa324a6ca6b20207cad248fec645446/z3c.boiler-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "7d676c67d2357f060e2f6055dd4dab14", "sha256": "f79048d9e4a58684bcc1019732625020632960cf957ea0c9f513c7d37527e81a" }, "downloads": -1, "filename": "z3c.boiler-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7d676c67d2357f060e2f6055dd4dab14", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9245, "upload_time": "2009-03-27T13:47:41", "url": "https://files.pythonhosted.org/packages/24/91/d2b961f62335196205fcf3dbf884e9cc036f1c11d6089f3b03811222bfc2/z3c.boiler-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7d676c67d2357f060e2f6055dd4dab14", "sha256": "f79048d9e4a58684bcc1019732625020632960cf957ea0c9f513c7d37527e81a" }, "downloads": -1, "filename": "z3c.boiler-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7d676c67d2357f060e2f6055dd4dab14", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9245, "upload_time": "2009-03-27T13:47:41", "url": "https://files.pythonhosted.org/packages/24/91/d2b961f62335196205fcf3dbf884e9cc036f1c11d6089f3b03811222bfc2/z3c.boiler-0.1.1.tar.gz" } ] }