-- ZopeRope - Various tools for migrating away from Zope (particularly v2) --


INTRO

--

Tool # 1 - zope2_fetch_objs.py

Zope External methods to extract Python Scripts and DTML Methods from your Zope 2 Data.fs over to your 
filesystem. They will extract everything off the root Zope instance structure, including everything 
within Products and within ZClasses that are embedded in products (recursively).

- Make sure zoperope_support_lib.py is copied somewhere in the Zope instances Python include path (one
option is bin/lib/ within the Zope instance
- Copy zope2_fetch_objs.py into Extensions folder
- Create any of these external methods (*in the root folder in your Zope instance management interface*):
	- First one (id: extract_pyscripts, module name: zope2_fetch_objs, function name: extract_pyscripts) 
	- Second one (id: extract_dtmlmethods, module name: zope2_fetch_objs, function: extract_dtmlmethods)
	- Third one (id: extract_tinytables, module name: zope2_fetch_objs, function: extract_dtmlmethods)
- Invoke from a url or from the Zope management interface: extract_pyscripts(full_path) or 
  extract_dtmlmethods(full_path)


--

Tool #2 - zope2_propertysheet_to_sql.py

 A Zope PythonScript that takes all property sheets for a ZClass instance and outputs the SQL schema for a 
singular table representing all the properties as well as an SQL insert representing that object's 
particular property values.

 Three notes you should read before attempting to use this:

 1. This is not a standalone Python script. Do not attempt to run it with your Python interpreter, it will 
    not run like that without adjustments. It's meant to be  created as a "Script (Python)" in Zope 2. Go 
    into the management interface, find the Zclass that you want to use it in, add a "Script (Python)" to 
    your ZClass, paste the code into it, save it, and execute it.

 2. This is intended to give you a bit of a head start in representing your ZClasses as SQL tables as you 
    migrate away from Zope 2. It should be a time saver if you are migrating away from Zope 2, have many 
    ZClasses, have used ZODB primarily, and need to design an SQL schema. Please note that you will most 
    likely have to tweak the resulting tables and add any relations you want. While this script should 
    give you a working SQL table and record, the SQL it outputs is obviously automated and supports a 
    limited number of SQL field types. 

 3. As of now, it only supports VARCHAR, INT, and FLOAT. Strings, no matter how long they are, will be 
    stuffed into a VARCHAR(255). If it is neither a string, integer, or float, the script will attempt to 
    put it into a VARCHAR(255).  I've tested this on 3 large production ZClasses with a variety of fields, 
    and in each case it produce valid SQL statements to build the table and insert the data

--

Tool #3 - zope2_gather_info.py


A Zope External method for the purposes of gather information about a Zope 2 instance that will be helpful 
in assessing what migration away from it will look like. It returns a dictionary

- Make sure zoperope_support_lib.py is copied somewhere in the Zope instances Python include path (one
option is bin/lib/ within the Zope instance
- Copy zope2_gather_info.py into Extensions folder
 - Create an external method *in the root folder in your Zope 
   instance management interface*:
	- (id: get_instance_info, module name: zope2_gather_info, 
	  function name: get_instance_info) 
 - Invoke it zope2_gather_info()


TODO

- Make zope2_gather_info more useful
- Add acl_user info to zope2_gather_info

AUTHOR

Mark J. Nenadov (2011)
* Essex, Ontario
* Email: <marknenadov@gmail.com> 


LICENSING

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version

This program is distributed in the hope that it will be useful
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.