[Checkins] SVN: zope.deprecation/trunk/ Release engineering.

Tue Apr 4 12:32:14 EDT 2006

Log message for revision 66407:
  Release engineering.

Changed:
  A   zope.deprecation/trunk/CHANGES.txt
  A   zope.deprecation/trunk/INSTALL.txt
  U   zope.deprecation/trunk/README.txt
  U   zope.deprecation/trunk/setup.py

-=-
Added: zope.deprecation/trunk/CHANGES.txt
===================================================================

--- zope.deprecation/trunk/CHANGES.txt	2006-04-04 16:21:21 UTC (rev 66406)
+++ zope.deprecation/trunk/CHANGES.txt	2006-04-04 16:32:14 UTC (rev 66407)
@@ -0,0 +1,17 @@
+zope.deprecation Package Changelog
+==================================
+
+zope.deprecation version 3.2.0 (2006/01/05)
+-------------------------------------------
+
+- Corresponds to the verison of the zope.deprecation package shipped as part of
+  the Zope 3.2.0 release.
+
+- Refactored to eliminate dependency on 'zope.proxy'. This was an especially
+  bad dependency due to the required C exension in 'zope.proxy'.
+
+zope.deprecation version 3.1.0 (2005/10/03)
+-------------------------------------------
+
+- Corresponds to the verison of the zope.deprecation package shipped as part of
+  the Zope 3.1.0 release.


Property changes on: zope.deprecation/trunk/CHANGES.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: zope.deprecation/trunk/INSTALL.txt
===================================================================
--- zope.deprecation/trunk/INSTALL.txt	2006-04-04 16:21:21 UTC (rev 66406)
+++ zope.deprecation/trunk/INSTALL.txt	2006-04-04 16:32:14 UTC (rev 66407)
@@ -0,0 +1,83 @@
+Installing This Package
+=======================
+
+Prerequisites
+-------------
+
+The installation steps below assume that you have the cool new 'setuptools'
+package installed in your Python.  Here is where to get it:
+
+  $ wget http://peak.telecommunity.com/dist/ez_setup.py
+  $ /path/to/your/python ez_setup.py # req. write access to 'site-packages'
+
+
+  - Docs for EasyInstall:
+    http://peak.telecommunity.com/DevCenter/EasyInstall
+
+  - Docs for setuptools:
+    http://peak.telecommunity.com/DevCenter/setuptools
+
+  - Docs for eggs:
+    http://peak.telecommunity.com/DevCenter/PythonEggs
+
+
+Installing a Development Checkout
+---------------------------------
+
+Check out the package from subversion:
+
+  $ svn co svn+ssh://svn.zope.org/repos/main/zope.deprecation/trunk \
+    src/zope.deprecation
+  $ cd src/zope.deprecation
+
+Install it as a "devlopment egg" (which also installs its "hard"
+dependencies):
+
+  $ /path/to/your/python setup.py devel
+
+The installation of dependency eggs uses the 'setup.cfg' file in
+the checkout.  You can supply '--find-links' on the command line to
+point it at a non-standard package repository.
+
+
+Running the Tests
+-----------------
+
+To test the package, you will also need the 'zope.testing' package, which
+can't (yet) be automatically installed.  Eventually, you should be able to
+type:
+
+  $ /path/to/your/python setup.py test
+
+and have it install the "testing dependencies."  Today, the workaround
+is to install it manually:
+
+  $ /path/to/easy_install --find-links="...." zope.testing
+
+You can then run the tests (finally) from the checkout directory:
+
+  $ /path/to/your/python test.py
+    Running:
+      .............
+    Ran 13 tests with 0 failures and 0 errors in 0.094 seconds.
+
+
+Installing a Source Distribution
+--------------------------------
+
+You can also install it from a source distribution:
+
+  $ /path/to/easy_install --find-links="...." -eb src zope.deprecation
+  $ cd src/zope.deprecation
+  $ /path/to/your/python setup.py devel
+
+
+Installing a Binary Egg
+-----------------------
+
+Install the package as a "binary egg" (which also installs its "hard"
+dependencies):
+
+  $ /path/to/easy_install --find-links="...." zope.deprecation
+
+


Property changes on: zope.deprecation/trunk/INSTALL.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: zope.deprecation/trunk/README.txt
===================================================================
--- zope.deprecation/trunk/README.txt	2006-04-04 16:21:21 UTC (rev 66406)
+++ zope.deprecation/trunk/README.txt	2006-04-04 16:32:14 UTC (rev 66407)
@@ -1,5 +1,41 @@
-===============
-Deprecation API
-===============
+zope.deprecation Package Readme
+===============================
 
-See ./src/zope/deprecation/README.txt for full details.
+Overview
+--------
+
+When we started working on Zope 3.1, we noticed that the hardest part of the
+development process was to ensure backward-compatibility and correctly mark
+deprecated modules, classes, functions, methods and properties. This package
+provides a simple function called 'deprecated(names, reason)' to deprecate the
+previously mentioned Python objects.
+
+Changes
+-------
+
+See CHANGES.txt.
+
+Installation
+------------
+
+See INSTALL.txt.
+
+
+Developer Resources
+-------------------
+
+- Subversion browser:
+
+  http://svn.zope.org/zope.deprecation/
+
+- Read-only Subversion checkout:
+
+  $ svn co svn://svn.zope.org/repos/main/zope.deprecation/trunk
+
+- Writable Subversion checkout:
+
+  $ svn co svn://svn.zope.org/repos/main/zope.deprecation/trunk
+
+- Note that the 'src/zope/deprecation' package is acutally a 'svn:externals'
+  link to the corresponding package in the Zope3 trunk (or to a specific tag,
+  for released versions of the package).

Modified: zope.deprecation/trunk/setup.py
===================================================================
--- zope.deprecation/trunk/setup.py	2006-04-04 16:21:21 UTC (rev 66406)
+++ zope.deprecation/trunk/setup.py	2006-04-04 16:32:14 UTC (rev 66407)
@@ -1,6 +1,6 @@
 ##############################################################################
 #
-# Copyright (c) 2004 Zope Corporation and Contributors.
+# Copyright (c) 2006 Zope Corporation and Contributors.
 # All Rights Reserved.
 #
 # This software is subject to the provisions of the Zope Public License,
@@ -32,6 +32,10 @@
       description='Zope 3 Deprecation Infrastructure',
       author='Zope Corporation and Contributors',
       author_email='zope3-dev at zope.org',
+      long_description="This package provides a simple function called "
+                       "'deprecated(names, reason)', which Zope3 uses to "
+                       "mark APIs and components which will be removed in "
+                       "future releases.",
       
       package_dir = {'': os.path.join(os.path.dirname(__file__), 'src')},
       packages=['zope', 'zope.deprecation'],

