{ "info": { "author": "Tres Seaver", "author_email": "tseaver@agendaless.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Plone", "Framework :: Zope2", "Intended Audience :: Developers", "License :: OSI Approved :: Zope Public License", "Programming Language :: Python", "Topic :: Software Development", "Topic :: Software Development :: Libraries :: Application Frameworks" ], "description": "FSDump Product Overview\n=======================\n\nFSDump grew out of an itch which many Zope developers have:\nthrough-the-web development is faster and easier to do, but\ncauses significant deployment and configuration management\nproblems. Through-the-web code cannot (easily) be checked into\nCVS, or diffed to show changes, or grepped to find the source\nof an error message.\n\nGoals\n-----\n\n- The first goal is to ease the burden of getting TTW code\n under version control: i.e., to make it possible to check\n a representation of the TTW code into CVS, and then to see\n what changes between versions.\n\n- Keep the file-system representations of the TTW objects \n simple and \"natural\" (we are explicitly avoiding XML here).\n\n- Future goals might include:\n\n o Two-way migration (e.g., make changes to dumped items in\n vim/emacs, and then import those changes back into the\n TTW code).\n\nInstallation\n------------\n\nSee the separate `installation directions `_.\n\n\nUsage\n-----\n\n- Use the \"Add list\" to create a \"Dumper\" instance in a folder\n (or Product) which contains the TTW code to be dumped.\n\n- Supply an absolute path to a directory on the filesystem\n in which the dumper is to create the files (note that the\n user as whom Zope is running needs write access to this\n directory). See the `form help `_.\n\n- Click the \"Change and Dump\" button to do the dump to the\n indicated directory.\n\n\nMapping TTW Code to the Filesystem\n----------------------------------\n\nSee the `mappings documentation `_.\n\n\nKnown Issues\n------------\n\n- Some types of metadata (``bobobase_modification_time``) won't\n be exported as a property.\n\n- See the `TODO list `_.\n\n------------------------------------------------------------\n\nEdit / Dump Dumper\n==================\n\nDescription\n-----------\n\nThe \"Edit / Dump\" view of an Dumper instance is used to set the\nfilesystem path to which the object's parent will be dumped, and\nto initiate this dumping.\nhow the operations\n\nControls\n--------\n\n``ID``\n The id of the Dumper object (readonly)\n\n``Filesystem path``\n The path under which the Dumper's parent will have its filesystem\n analog (a subdirectory) created. All children of the Dumper's\n parent will have their analogs created under this subdirectory.\n E.g., if the value of this field is ``/tmp``, and the parent folder\n is called ``parent_folder``, then the dumper will create a\n subdirectory, ``/tmp/parent_folder``, and build objects in it\n corresponding to the dumper's \"siblings\".\n\n``Use .metadata file``\n If checked, write a \"new-style\" .metadata file, in a format\n compatilbie with CMF 1.4 and later. Properties go into the\n ``[Default]`` section.\n\n``Change``\n Changes the filesystem mapping.\n\n``Change and Dump``\n Changes the filesystem mapping and performs the dumping.\n\n------------------------------------------------------------\n\nMapping TTW Code to the Filesystem\n==================================\n\nGeneral Mapping\n---------------\n\n- Create the most \"natural\" filesystem analogue for each TTW\n item: Folders -> directories, DTML Methods/Documents ->\n DTML files, PythonMethods -> Python modules.\n\n- Trap non-inline properties in a companion file, with a\n ``.properties`` suffix. Store one property per line, using\n ``name:type=value`` syntax.\n\n * XXX: in companion ``.metadata`` file, store the properties\n in the ``[Default]`` section.\n\n- Map the permission-role map in the ``[Permissions]`` section of the\n companion ``.metadata`` file (XXX this feature not present before\n the switch to ``.metadata``, although it might have mapped to the\n ``.security`` file supported by CMF 1.3)\n\n- Map local roles in the ``[LocalRoles]`` section of the\n companion ``.metadata`` file (XXX this feature not present before\n the switch to ``.metadata``)\n\n- Write proxy roles to a ``proxy`` property (XXX CMF 1.4 compatibility;\n this is an *ugly* spelling). Should probably put it into a \"prettier\"\n spelling, as well, and lobby to change the spelling used in CMF.\n\n- Preserve enough metadata to be able to recreate the TTW\n object, preferably by *using its web interface.* This rule\n is the chief differentiator (in concept) from pickling; we\n don't save state which cannot be set by a TTW manager.\n\nSpecific Mappings\n-----------------\n\nFolder\n%%%%%%\n\n- Recursively store contained items into the folder's directory.\n\n- Store a list of the dumped items in an ``.objects`` file,\n one line per item, using the format, ``name:meta_type``.\n\n * XXX: in ``.metadata`` file, store the same lines in an\n ``[Objects]`` directory.\n\nFile / Image\n%%%%%%%%%%%%\n\n- Save the file contents themselves in binary format using the item's id.\n\n- Store properties in ``*.properties``.\n\nDTMLMethod\n%%%%%%%%%%\n\n- Create a single file containng the text of the template. Filename will\n have extension, ``.dtml``.\n\nDTMLDocument\n%%%%%%%%%%%%\n\n- Create a single file containng the text of the template. Filename will\n have extension, ``.dtml``.\n\n- Store properties in ``*.properties``.\n\nPython Script\n%%%%%%%%%%%%%\n\n- Create a module containing a single top-level function definition, using\n the \"read\" format (bindings in comments at the top).\n\nPageTemplate\n%%%%%%%%%%%%\n\n- Create a single file containng the text of the template. Filename will\n have extension, ``.pt``.\n\n- Store properties in ``*.properties``.\n\nSQL Method\n%%%%%%%%%%\n\n- Inject the parameter list inline into the body, with a leading blank line.\n\nZCatalog\n%%%%%%%%\n\n- Store the paths of the catalogued objects in a ``.catalog`` file,\n one line per item.\n\n- Store the index definititions in a ``.indexes`` file,\n one line per index, using the format, ``name:meta_type``.\n\n- Store the schema in a ``.metadata`` file, one line per\n field name.\n\nController Python Script\n%%%%%%%%%%%%%%%%%%%%%%%%\n\n- Create a module containing a single top-level function\n definition, using the \"read\" format (bindings in comments\n at the top). Filename will have extension, ``.cpy``\n\n- Store properties in ``*.properties``.\n\nController Validator\n%%%%%%%%%%%%%%%%%%%%\n\n- Create a module containing a single top-level function\n definition, using the \"read\" format (bindings in comments\n at the top). Filename will have extension, ``.vpy``\n\n- Store properties in ``*.properties``.\n\nController Page Template\n%%%%%%%%%%%%%%%%%%%%%%%%\n\n- Create a single file containng the text of the template.\n Filename will have extension, ``.cpt``.\n\n- Store properties in ``*.properties``.\n\n\nMappings for Obsolete Types\n---------------------------\n\nPython Method\n%%%%%%%%%%%%%\n\n- Create a module containing a single top-level function\n definition, using the name, argument list, and body.\n\nZClass\n%%%%%%\n\n- Map to a directory.\n\n- Store \"basic\" tab values in ``.properties``\n\n- Store icon in ``.icon``\n\n- Store propertysheets in ``propertysheets/common``.\n\n- Store method tab objects (including nested ZClasses)\n in ``propertysheets/methods``.\n\nCommon Instance Property Sheet (ZClass property sheet)\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\n\n- Store properties as ``name:type=value`` in file of same name.\n\nZope Permission\n%%%%%%%%%%%%%%%\n\n- Store values in ``*.properties``.\n\nZope Factory\n%%%%%%%%%%%%\n\n- Store values in ``*.properties``.\n\nWizard\n%%%%%%\n\n- Map to a directory.\n\n- Store properties in ``.properties``.\n\n- Store pages.\n\nWizardPage\n%%%%%%%%%%\n\n- Store text in ``*.wizardpage``.\n\n- Store properties in ``*.properties``.\n\n------------------------------------------------------------\n\nFSDump Changelog\n================\n\n0.9.5 (2009-11-03)\n------------------\n\n- Removed broken HelpSys registrations.\n\n- Fixed the version number used in making the sdist.\n\n\n0.9.4 (2009-02-22)\n------------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/0.9.4\n\n- Repackaged as a Python egg.\n\n- Converted docs to ReStructured text.\n\n- Moved from CVS to SVN.\n\n\n0.9.3 (2006-12-20)\n------------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_3\n\n- Applied patch from Damine Baty, fixing the output of dumping ZSQLMethods\n to match the format used by CMF's FSZSQLMethods.\n \n- Applied patch from Alejo Roda, adding a handler for Formulator forms.\n\n- Applied patch from Willi Langenburger, adding a handler for ZWikiPage\n objects.\n\n\n0.9.2 (2005-08-09)\n-------------------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_2\n\n- CVS tag: ``FSDump-0_9_2``\n\n- Reverted ``handler_overrides`` brownbag\n\n\n0.9.1 (2005-08-09)\n------------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_1\n\n- CVS tag: ``FSDump-0_9_1``\n\n- Added argument to Dumper factory to allow caller to supply handler\n overrides.\n\n- Applied patch from Sam Brauer, addressing the following issues:\n\n * Proxy roles and security settings weren't being written to\n the ``.metadata`` file.\n\n * The ``[Default]`` section should be named ``[default]``.\n\n * The property-type extensions confuse CMF's FilesystemDirectoryView\n (the patch removes the ``:string`` for string properties; others\n are likely still broken).\n\n \n0.9 (2005-04-29)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_9\n\n- CVS tag: ``FSDump-0_9``\n\n- Merged Andy Fundinger's work, adding handlers for the following\n CMFFormController meta_types:\n\n * ControllerPythonScript\n\n * ControllerValidator\n\n * ControllerPageTemplates\n\n- Fix missing import of ConflictError (thanks to Willi Langenburger\n for the patch).\n\n- Applied a patch from Willi Langenburger to permit use of a dumper\n in the root of the Zope instance.\n\n\n0.8.1 (2004-12-09)\n------------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_8_1\n\n- CVS tag: ``FSDump-0_8_1``\n\n- Repackaged to nest the actual products directory inside a version-\n qualified wrapper directory; added an INSTALL.txt in the wrapper.\n\n\n0.8 (2004-10-13)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_8\n\n- CVS tag: ``FSDump-0_8``\n\n- Applied patch from Zope collector #1463 to make dumped SQL methods\n fit better with CMF's FSSQLMethod representation.\n\n\n0.7 (2004-05-17)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_7\n\n- CVS tag: ``FSDump-0_7``\n\n- Added knob to force use of single ``.metadata`` file, rather than\n multiples (CMF 1.4 compatibility).\n\n- Migrated ZMI to use PageTemplates.\n\n- Bug: when synthesizing a file extension, Dumper didn't include the\n synthesized extension in the name of the \"companion\" properties file.\n\n\n0.6 (2001-08-09)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_6\n\n- CVS tag: ``FSDump-0_6``\n\n- Add handlers for:\n\n - PageTemplate\n\n\n0.5 (2001-08-03)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_5\n\n- CVS tag: ``FSDump-0_5``\n\n- Add handlers for:\n\n - PythonScript\n\n\n0.4 (2001-06-18)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_4\n\n- CVS tag: ``FSDump-0_4``\n\n- Conform to the \"Finished Project Guidelines\",\n http://dev.zope.org/Wikis/DevSite/Proposals/FinishedProductGuidelines\n\n- Added HelpSystem stuff.\n\n- Moved to use declarative security.\n\n\n0.3 (2001-01-06)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_3\n\n- No CVS tag?\n\n- Dump ZClass icon.\n\n- Add handlers for:\n\n * Wizards\n\n * Wizard Pages\n\n\n0.2 (2000-11-19)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_2\n\n- CVS tag: ``FSDump-0_2``\n\n- Add handlers for:\n\n * ZClasses\n\n * ZClass property sheets\n\n * TTW Permissions\n\n * TTW Factories\n\n\n- Fix unixism in ``Dumper._setFSPath()`` -- thanks Craig! (cba@mediaone.net)\n\n0.1 (2000-11-16)\n----------------\n\n- SVN: http://svn.zope.org/Products.FSDump/tags/FSDump-0_1\n\n- CVS tag: ``FSDump-0_1``\n\n- Initial release\n\n------------------------------------------------------------\n\nDownload\n========", "description_content_type": null, "docs_url": "https://pythonhosted.org/Products.FSDump/", "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/Products.FSDump", "keywords": "web application server zope zope2", "license": "ZPL 2.1 (http://www.zope.org/Resources/License/ZPL-2.1)", "maintainer": null, "maintainer_email": null, "name": "Products.FSDump", "package_url": "https://pypi.org/project/Products.FSDump/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/Products.FSDump/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/Products.FSDump" }, "release_url": "https://pypi.org/project/Products.FSDump/0.9.5/", "requires_dist": null, "requires_python": null, "summary": "Dump through-the-web Zope objects to the filesystem", "version": "0.9.5" }, "last_serial": 803676, "releases": { "0.9.5": [ { "comment_text": "", "digests": { "md5": "422e0c4e44a4afbc56200eda6d23765a", "sha256": "c911036afd29b829a422bf61c3642d8e44e70eeb13e9b5a5fb02a73fe7fc1db1" }, "downloads": -1, "filename": "Products.FSDump-0.9.5.tar.gz", "has_sig": false, "md5_digest": "422e0c4e44a4afbc56200eda6d23765a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20319, "upload_time": "2009-11-03T15:54:55", "url": "https://files.pythonhosted.org/packages/50/3a/a76ef772f3bc0b5db163d67b039ffee31704b92ec90f37882fa555061224/Products.FSDump-0.9.5.tar.gz" } ], "FSDump-0.9.4": [ { "comment_text": "", "digests": { "md5": "0d4568151c2a9c9c705321750a978932", "sha256": "4c630ddaed16f89a172ed38274c26319d3a69f2ce0afce245ef1a5832830a46b" }, "downloads": -1, "filename": "Products.FSDump-FSDump-0.9.4.tar.gz", "has_sig": false, "md5_digest": "0d4568151c2a9c9c705321750a978932", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20288, "upload_time": "2009-02-22T18:45:35", "url": "https://files.pythonhosted.org/packages/86/ef/f1a2d9f0dd8b4f18f15cc00371dcbfe04c3891c715d7f5796a772d4dd64d/Products.FSDump-FSDump-0.9.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "422e0c4e44a4afbc56200eda6d23765a", "sha256": "c911036afd29b829a422bf61c3642d8e44e70eeb13e9b5a5fb02a73fe7fc1db1" }, "downloads": -1, "filename": "Products.FSDump-0.9.5.tar.gz", "has_sig": false, "md5_digest": "422e0c4e44a4afbc56200eda6d23765a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20319, "upload_time": "2009-11-03T15:54:55", "url": "https://files.pythonhosted.org/packages/50/3a/a76ef772f3bc0b5db163d67b039ffee31704b92ec90f37882fa555061224/Products.FSDump-0.9.5.tar.gz" } ] }