{ "info": { "author": "Paul Carduner, Stephan Richter, and hopefully others...", "author_email": "zope-dev@zope.org", "bugtrack_url": null, "classifiers": [], "description": "======================================\nThe Zope 3 Community's Project Builder\n======================================\n\nz3c.builder is a tool that helps you jump start development of a Zope\n3 application by generating all the boiler plate code and\nconfiguration for you.\n\nGoals\n-----\n\n * Easy to use\n * Easy to extend\n * More or less complete\n\n\nBrainstorming\n-------------\n\nThe easiest thing to tackle is just generating all the files that are\nneeded without necessarily any customizable contents. A minimal eggs\nand buildout based project would have a directory structure like this::\n\n package-name/\n bootstrap.py\n buildout.cfg\n setup.py\n README.txt\n CHANGES.txt\n src/\n namespace-package/\n __init__.py\n package/\n __init__.py\n\nEach section of this directory structure can be further configured ad\ninfinitum. The tricky part is deciding when enough is enough. Let's\nconsider each of these sections and what they offer.\n\nbootstrap.py\n~~~~~~~~~~~~\n\nThis is brain dead simple. There is a standard file that everyone\nuses and we just need to copy it in. I don't think there is any\npotential customization points.\n\n\nbuildout.cfg\n~~~~~~~~~~~~\n\nThere are pretty much an infinite number of generic customizations you\ncan make to a buildout.cfg file. Here are some of the ones we might\nwant to support out of the box:\n\n - Creation of multiple buildout.cfg files, for different uses\n (developers, production, minimal?)\n\n - kgs hookup, with support for using a remote extends buildout\n option, or downloading a versions.cfg file upon project creation.\n\n - Some typically used and useful parts:\n - tests\n - coverage\n - python interpreter\n - ctags\n - documentation generators\n\n (note that some of these parts require additional files to be\n added to the src tree in order to make sense)\n\n - Zope Server setup.\n This bleeds into all the zope 3 configuration that we might\n want to do and also paster setup. This would include basically\n anything you can configure in zope.conf files.\n\nsetup.py\n~~~~~~~~\n\nThis is relatively straight forward. There are the obvious keyword\narguments that are passed to the setup() command that we'll want to\nconfigure. There are however some slightly more interesting peices:\n\n - long_description: Since this is what becomes the python page,\n we'll want to hook up the boiler plate code for using a\n combination of README.txt, CHANGES.txt and others to generate the\n full long description. This shouldn't be that hard.\n\n - classifiers: It's always a pain in the ass to remember what all\n the different classifiers can be and how they should be\n formatted.\n\n - extras_requires: we may want to configure what extras_requires\n sections there are. Typically we would have a test and an app\n section. There might also be a docs section and others.\n\n - entry_points: this is where it gets a bit trickier. Paster has\n it's own entry point boiler plate code that you need. We may also\n want to configure any number of additonal command line script\n entry points.\n\nREADME.txt\n~~~~~~~~~~\n\nJust a simple file dump with maybe some configurable initial content.\n\nCHANGES.txt\n~~~~~~~~~~~\n\nAnother simple file dump with an example of the change log format that\nwe've standardized on.\n\nOther Python Files\n~~~~~~~~~~~~~~~~~~\n\nThe rest of the files are just for mkaing proper python modules and\nshould be brain dead simple.\n\nConclusion\n~~~~~~~~~~\n\nI think starting by making a project builder for simple egg/buildout\nbased projects is a good starting point. It's an atainable and useful\ngoal which will give us the experience we need to tackle the more\ncomplex task of zope boiler plate.\n\n\n=======\nCHANGES\n=======\n\nVersion 0.1.0 (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.builder.core", "keywords": "zope3 project builder", "license": "ZPL 2.1", "maintainer": null, "maintainer_email": null, "name": "z3c.builder.core", "package_url": "https://pypi.org/project/z3c.builder.core/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/z3c.builder.core/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/z3c.builder.core" }, "release_url": "https://pypi.org/project/z3c.builder.core/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "A utility to help jump start Zope 3 projects", "version": "0.1.0" }, "last_serial": 802002, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1173c363f489d47f050fb104bf515b54", "sha256": "dc272ef0194ec5ca00769bce0f637ec6fadee4eb29667337ea5d9f9e1325a9b4" }, "downloads": -1, "filename": "z3c.builder.core-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1173c363f489d47f050fb104bf515b54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 140915, "upload_time": "2009-03-27T11:39:49", "url": "https://files.pythonhosted.org/packages/28/5c/5a6467ba246fd1c93964808306b11a2f2fa191c5381a092079936c3bb785/z3c.builder.core-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1173c363f489d47f050fb104bf515b54", "sha256": "dc272ef0194ec5ca00769bce0f637ec6fadee4eb29667337ea5d9f9e1325a9b4" }, "downloads": -1, "filename": "z3c.builder.core-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1173c363f489d47f050fb104bf515b54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 140915, "upload_time": "2009-03-27T11:39:49", "url": "https://files.pythonhosted.org/packages/28/5c/5a6467ba246fd1c93964808306b11a2f2fa191c5381a092079936c3bb785/z3c.builder.core-0.1.0.tar.gz" } ] }