[Checkins] SVN: Sandbox/ctheune/zodbupgrade/ Release-preparation: licensing, documentation

Christian Theune ct at gocept.com
Mon Jun 8 02:57:52 EDT 2009 

Log message for revision 100725:
  Release-preparation: licensing, documentation
  

Changed:
  _U  Sandbox/ctheune/zodbupgrade/
  A   Sandbox/ctheune/zodbupgrade/CHANGES.txt
  A   Sandbox/ctheune/zodbupgrade/COPYRIGHT.txt
  A   Sandbox/ctheune/zodbupgrade/LICENSE.txt
  A   Sandbox/ctheune/zodbupgrade/README.txt
  A   Sandbox/ctheune/zodbupgrade/TODO.txt
  U   Sandbox/ctheune/zodbupgrade/setup.py

-=-

Property changes on: Sandbox/ctheune/zodbupgrade
___________________________________________________________________
Modified: svn:ignore
   - develop-eggs
parts
.installed.cfg
bin


   + develop-eggs
build
dist
parts
.installed.cfg
bin



Added: Sandbox/ctheune/zodbupgrade/CHANGES.txt
===================================================================
--- Sandbox/ctheune/zodbupgrade/CHANGES.txt	                        (rev 0)
+++ Sandbox/ctheune/zodbupgrade/CHANGES.txt	2009-06-08 06:57:52 UTC (rev 100725)
@@ -0,0 +1,7 @@
+Changes
+=======
+
+0.1 (unreleased)
+----------------
+
+- First release.


Property changes on: Sandbox/ctheune/zodbupgrade/CHANGES.txt
___________________________________________________________________
Added: svn:eol-style
   + native

Added: Sandbox/ctheune/zodbupgrade/COPYRIGHT.txt
===================================================================
--- Sandbox/ctheune/zodbupgrade/COPYRIGHT.txt	                        (rev 0)
+++ Sandbox/ctheune/zodbupgrade/COPYRIGHT.txt	2009-06-08 06:57:52 UTC (rev 100725)
@@ -0,0 +1,9 @@
+Copyright (c) 2009 Zope Corporation and Contributors.
+All Rights Reserved.
+
+This software is subject to the provisions of the Zope Public License,
+Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+FOR A PARTICULAR PURPOSE. 


Property changes on: Sandbox/ctheune/zodbupgrade/COPYRIGHT.txt
___________________________________________________________________
Added: svn:eol-style
   + native

Added: Sandbox/ctheune/zodbupgrade/LICENSE.txt
===================================================================
--- Sandbox/ctheune/zodbupgrade/LICENSE.txt	                        (rev 0)
+++ Sandbox/ctheune/zodbupgrade/LICENSE.txt	2009-06-08 06:57:52 UTC (rev 100725)
@@ -0,0 +1,44 @@
+Zope Public License (ZPL) Version 2.1
+
+A copyright notice accompanies this license document that identifies the
+copyright holders.
+
+This license has been certified as open source. It has also been designated as
+GPL compatible by the Free Software Foundation (FSF).
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions in source code must retain the accompanying copyright
+notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the accompanying copyright
+notice, this list of conditions, and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Names of the copyright holders must not be used to endorse or promote
+products derived from this software without prior written permission from the
+copyright holders.
+
+4. The right to distribute this software or to use it for any purpose does not
+give you the right to use Servicemarks (sm) or Trademarks (tm) of the copyright
+holders. Use of them is covered by separate agreement with the copyright
+holders.
+
+5. If any files are modified, you must cause the modified files to carry
+prominent notices stating that you changed the files and the date of any
+change.
+
+Disclaimer
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+


Property changes on: Sandbox/ctheune/zodbupgrade/LICENSE.txt
___________________________________________________________________
Added: svn:eol-style
   + native

Added: Sandbox/ctheune/zodbupgrade/README.txt
===================================================================
--- Sandbox/ctheune/zodbupgrade/README.txt	                        (rev 0)
+++ Sandbox/ctheune/zodbupgrade/README.txt	2009-06-08 06:57:52 UTC (rev 100725)
@@ -0,0 +1,67 @@
+==================================================================
+zodbupgrade - Upgrade an existing databases to match your software
+==================================================================
+
+This package provides a tool that automatically identifies and updates
+references from persistent objects to classes that are in the process of being
+moved from one module to another and/or being renamed.
+
+If a class is being moved or renamed, you need to update all references from
+your database to this name before finally deleting the old code.
+
+This tool looks through all current objects of your database, identifies
+moved/renamed classes and `touches` objects accordingly. It creates a single
+transaction that contains the update of your database.
+
+Having run this tool, you are then able to delete the old code.
+
+Usage
+=====
+
+Installing the egg of this tool provides a console script `zodbupgrade` which
+you can call giving either a FileStorage filename or a configuration file
+defining a storage::
+
+    $ zodbupgrade -f Data.fs
+    $ zodbupgrade -c zodb.conf
+
+Detailed usage information is available:
+
+    $ zodbupgrade -h
+
+Custom software/eggs
+--------------------
+
+It is important to install this egg in an interpreter/environment where your
+software is installed as well. If you're using a regular Python installation
+or virtualenv, just installing the package using easy_install should be fine.
+
+If you are using buildout, installing can be done using the egg recipe with
+this configuration::
+
+    [buildout]
+    parts += zodbupgrade
+
+    [zodbupgrade]
+    recipe = zc.recipe.eggs
+    eggs = zodbupgrade
+        <list additional eggs here>
+
+If you do not install `zodbupgrade` together with the necessary software it
+will report missing classes and not touch your database.
+
+Non-FileStorage configurations
+------------------------------
+
+You can configure any storage known to your ZODB installation by providing a
+ZConfig configuration file (similar to zope.conf). For example you can connect
+to a ZEO server by providing a config file `zeo.conf`::
+
+    <zeoclient>
+        server 127.0.0.1:8100
+        storage 1
+    </zeoclient>
+
+And then running `zodbupgrade` using:
+
+    $ zodbupgrade -c zeo.conf


Property changes on: Sandbox/ctheune/zodbupgrade/README.txt
___________________________________________________________________
Added: svn:eol-style
   + native

Added: Sandbox/ctheune/zodbupgrade/TODO.txt
===================================================================
--- Sandbox/ctheune/zodbupgrade/TODO.txt	                        (rev 0)
+++ Sandbox/ctheune/zodbupgrade/TODO.txt	2009-06-08 06:57:52 UTC (rev 100725)
@@ -0,0 +1,9 @@
+TODO
+====
+
+- Compress repeated warnings, ignore warnings that are known to come from the
+  framework (factory PermissionSetting: Allow does not have __name__, can't
+  check canonical location)
+
+- Provide "offline" updating: read a list of old/new pairs and update pickles
+  directly without needing the old code


Property changes on: Sandbox/ctheune/zodbupgrade/TODO.txt
___________________________________________________________________
Added: svn:eol-style
   + native

Modified: Sandbox/ctheune/zodbupgrade/setup.py
===================================================================
--- Sandbox/ctheune/zodbupgrade/setup.py	2009-06-08 06:57:11 UTC (rev 100724)
+++ Sandbox/ctheune/zodbupgrade/setup.py	2009-06-08 06:57:52 UTC (rev 100725)
@@ -19,9 +19,14 @@
       author='Zope Developers',
       author_email='zodb-dev at zope.org',
       description=
-        'Transparently update ZODB class references to their '
-        'canonical locations',
-      version='0.1',
+        'Update ZODB class references for moved or renamed classes.',
+      long_description=(
+        read('README.txt')
+        + '\n' +
+        read('TODO.txt')
+        + '\n' +
+        read('CHANGES.txt')),
+      version='0.1dev',
       package_dir={'': 'src'},
       packages=find_packages('src'),
       include_package_data=True,

More information about the Checkins mailing list