| TransWarp Preview Release 0.1 |
PEAK Release 0.5 alpha 4 |
| |
|
| Copyright (C) 2001 Phillip J. Eby, All rights reserved. |
Copyright (C) 1996-2004 by Phillip J. Eby and Tyler C. Sarna. |
| This software may be used under the same terms as Zope or Python. |
All rights reserved. This software may be used under the same terms |
| |
as Zope or Python. THERE ARE ABSOLUTELY NO WARRANTIES OF ANY KIND. |
| |
Code quality varies between modules, from "beta" to "experimental |
| |
pre-alpha". :) |
| |
|
| Please see http://www.zope.org/Members/pje/Wikis/TransWarp for tutorials, |
Package Description |
| FAQs, package layout, etc. Selected pages from the Wiki are included |
|
| in the docs/ directory for your convenience. |
|
| |
|
| At this time, the 'Features', 'Aspects', 'SOX', and 'tests' modules |
PEAK is the "Python Enterprise Application Kit". If you develop |
| and packages are usable, if not necessarily full-featured. All other |
"enterprise" applications with Python, or indeed almost any sort of |
| modules/packages (except as imported by the above) are under heavy |
application with Python, PEAK may help you do it faster, easier, on a |
| construction - don't enter without a hard hat! (That is, |
larger scale, and with fewer defects than ever before. The key is |
| use them at your own risk. Although, there's no warranty that any of |
component-based development, on a reliable infrastructure. |
| the other stuff works, beyond the fact that the tests run on my |
|
| home computer.) |
|
| |
|
| |
PEAK tools can be used with other "Python Enterprise" frameworks such as |
| |
Zope, Twisted, and the Python DBAPI to construct web-based, GUI, or |
| |
command-line applications, interacting with any kind of storage, or with |
| |
no storage at all. Whatever the application type, PEAK can help you put |
| |
it together. |
| |
|
| INSTALLATION INSTRUCTIONS |
Package Features |
| |
|
| To use this package, you will need to install it by placing the TW/ directory |
Far too many to list even briefly here: see FEATURES.txt for a very high |
| inside a directory which is listed in your Python path. You will also need |
level overview. |
| to install Aaron Watters' "kjbuckets" library, and Jim Fulton's "Scarecrow" |
|
| Interfaces package. |
|
| |
|
| Later versions will hopefully automate some of this as we learn to use the |
|
| Python distutils, but for now, you have to do everything yourself... |
|
| |
|
| Getting and Installing kjbuckets |
|
| |
|
| Unix Platforms |
|
| |
|
| You can download the C source code for kjbuckets at: |
|
| |
|
| http://www.chordate.com/kjbuckets/ |
|
| |
|
| And build as you would any other Python module. |
|
| |
|
| Windows Platforms |
|
| |
|
| If you're using Python 1.5, you can download a pre-built kjbuckets.pyd at: |
|
| |
|
| http://www.chordate.com/kwParsing/kjbuckets.pyd |
|
| |
|
| And then place it in your Python path. If you're using Python 2.0, |
|
| or can't get this to work, see "If You Can't Compile kjbuckets" below. |
|
| |
|
| If You Can't Compile kjbuckets |
|
| |
|
| If for whatever reason you can't get the C version of kjbuckets to work |
|
| on your system, download this file: |
|
| |
|
| http://www.chordate.com/kwParsing/kjbuckets0.py |
|
| |
|
| Rename it to "kjbuckets.py", and place it in your Python path. This runs |
|
| slower than the C version, but it'll do in a pinch. |
|
| |
|
| Getting and Installing the Interface package (aka "The Scarecrow") |
Known Issues and Risks of this Version |
| |
|
| |
This is ALPHA software. Although much of the system is extensively |
| |
tested by a battery of automated tests, it may contain bugs, especially |
| |
in areas not covered by the test suites. Also, many system interfaces |
| |
are still subject to change. |
| |
|
| |
PEAK includes early copies of Zope X3's 'ZConfig' and 'persistence' |
| |
packages, which have had - and may continue to have - significant |
| |
implementation changes. We will be tracking Zope X3 periodically, but |
| |
can't guarantee compatibility with arbitrary (e.g. CVS) versions of |
| |
Zope X3. |
| |
|
| |
Documentation at present is limited, and scattered. The principal |
| |
documentation is an API reference generated from the code's lengthy |
| |
docstrings (which usually contain motivating examples for using that |
| |
class, method, or function). The mailing list and its archives |
| |
provide a wealth of information on actual usage scenarios, |
| |
recommended approaches, etc. There is also the beginnings of a |
| |
tutorial on using the component binding package. |
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
Third-Party Software Included with PEAK |
| |
|
| |
All third-party software included with PEAK are understood by PEAK's |
| |
authors to be distributable under terms comparable to those PEAK is |
| |
offered under. However, it is up to you to understand any obligations |
| |
those licenses may impose upon you. For your reference, here are the |
| |
third-party packages and where to find their license terms: |
| |
|
| |
The 'kjbuckets' module is Copyright Aaron Watters and contributors; |
| |
please see the 'src/kjbuckets/COPYRIGHT.txt' file for details of its |
| |
license. |
| |
|
| |
The 'csv' module is part of Python 2.3 and above, and is included for |
| |
backward compatibility in Python 2.2. See the Python license for license |
| |
details. |
| |
|
| |
The 'datetime', 'persistence' and 'ZConfig' packages are Copyright Zope |
| |
Corporation and contributors; please see the 'LICENSE.txt' files in their |
| |
directories for details of their licenses. |
| |
|
| |
The 'fcgiapp' module is Copyright Digital Creations, LC (now Zope Corp.); |
| |
see the 'fcgiappmodule.c' for details of its license. In the same |
| |
directory are distributed portions of the FastCGI Development Kit, which |
| |
is Copyright Open Market, Inc. See the 'LICENSE.TERMS' file in that |
| |
directory for details of its license. |
| |
|
| |
Installation Instructions |
| |
|
| |
Please see the INSTALL.txt file. |
| |
|
| |
|
| |
|
| The easiest place to find a copy of the Interface package is in the |
|
| lib/python directory of a Zope installation. Just copy it over to your |
|
| main Python path, or add the lib/python directory to your Python path. |
|
| |
|
| Failing that, you can look at this URL for downloads: |
|
| |
|
| http://www.zope.org/Members/michel/Products/Interfaces/ |
|
| |
|
| This may not be the best place for an up-to-date copy, but the current |
|
| TransWarp code doesn't do much with interfaces yet, so it probably doesn't |
|
| matter right now. |
|
| |
|
| |
|
| TESTING YOUR INSTALLATION |
|
| |
|
| TransWarp comes with a fairly hefty built-in test suite. If you have |
|
| the Python "unittest" module installed in your Python path, you can use |
|
| it to run the test suites, like this:: |
|
| |
|
| python unittest.py TW.tests.suite |
|
| |
|
| This will run about 114 tests on various parts of TransWarp. If you have |
|
| installed everything correctly, 100% of the tests should succeed. If |
|
| you're missing any needed parts, you will probably experience a massive |
|
| number of failures and errors. |
|
| |
|
Diff of /PEAK/README.txt
Parent Directory
| 
Revision Log