| SYSTEM REQUIREMENTS |
SYSTEM REQUIREMENTS |
| |
|
| Python 2.2.2 or better is required. Some portions of PEAK may support only |
Python 2.2.2 or better is required. Some portions of PEAK may support only |
| POSIX-like and/or Windows operating systems. |
POSIX-like and/or Windows operating systems. Installation from a source |
| |
distribution requires a C compiler that works with Python. |
| |
|
| Note: if you have installed previous versions of PEAK or TransWarp, be |
If you are modifying the source of PEAK extension modules, you will need |
| sure to remove them before installing this one. A lot of things have |
Pyrex version 0.7.2. You do not need Pyrex if you are just installing |
| moved, been removed, or just plain ain't the same. |
PEAK as-is, but if you *do* have Pyrex installed, it must be version 0.7.2. |
| |
|
| |
In general, it is best to uninstall previous versions of PEAK before |
| |
installing new ones, since some modules may have moved or been renamed. |
| |
|
| |
|
| BASIC INSTALLATION |
BASIC INSTALLATION |
| |
|
| PEAK is distributed using the now-standard Python 'distutils' protocol. |
PEAK is distributed using the now-standard Python 'distutils' utilities. |
| Just unpack the archive, go to the directory containing 'setup.py', and run:: |
Just unpack the archive, go to the directory containing 'setup.py', and |
| |
run:: |
| |
|
| python setup.py install |
python setup.py install |
| |
|
| Modules" section of the Python manuals for details on customizing |
Modules" section of the Python manuals for details on customizing |
| installation locations, etc.). |
installation locations, etc.). |
| |
|
| |
(Note: for the Win32 installer release, just run the .exe file.) |
| |
|
| |
|
| SCRIPTS |
SCRIPTS |
| |
|
| On operating systems where 'os.name == "posix"', PEAK installs a Python |
On operating systems where 'os.name == "posix"', PEAK installs a Python |
| Run the 'peak' script for usage info, or see the 'Bootstrap' class in |
Run the 'peak' script for usage info, or see the 'Bootstrap' class in |
| 'peak.running.commands' for more on how to make objects bootable via 'peak'. |
'peak.running.commands' for more on how to make objects bootable via 'peak'. |
| |
|
| |
|
| |
|
| |
TESTING YOUR INSTALLATION |
| |
|
| |
PEAK comes with a moderately-sized built-in test suite. If you wish to |
| |
run it after installation, and you are installing from source, you can do |
| |
so like this:: |
| |
|
| |
python setup.py test |
| |
|
| |
This will run over 120 tests on various parts of PEAK. If you have |
| |
installed everything correctly, 100% of the tests should succeed. If |
| |
anything is broken, you will probably be unable to run the tests at all. |
| |
|
| |
If you'd like to run only a portion of the test suite, you can supply |
| |
the '--test-module' or '-m' option to the test command as follows:: |
| |
|
| |
python setup.py test --test-module=peak.util.tests |
| |
|
| |
python setup.py test -m peak.tests |
| |
|
| |
And so on. You can also use 'python setup.py -q test' to make the tests |
| |
run more "quietly". |
| |
|
| |
If you've installed using the Windows binary installer, you can run the |
| |
tests like this:: |
| |
|
| |
python C:\Python22\Lib\unittests.py peak.tests.test_suite |
| |
|
| |
(Substitute the location of 'unittests.py' on your machine; it'll be in |
| |
the 'Lib' subdirectory of your python installation.) |
| |
|
| |
|
| THIRD PARTY SOFTWARE INCLUDED WITH PEAK |
THIRD PARTY SOFTWARE INCLUDED WITH PEAK |
| |
|
| Aaron Watters' 'kjbuckets' Module |
Aaron Watters' 'kjbuckets' Module |
| 'kjbuckets' is copyright Aaron Watters and contributors; please see |
'kjbuckets' is copyright Aaron Watters and contributors; please see |
| the 'src/kjbuckets/COPYRIGHT.txt' file for details of its license. |
the 'src/kjbuckets/COPYRIGHT.txt' file for details of its license. |
| |
|
| The Zope 3 'Interface' and 'Persistence' Packages |
|
| |
The Zope 3 'persistence' and 'ZConfig' Packages |
| |
|
| PEAK includes a copy of the following packages from the Zope X3 Milestone 2 |
PEAK includes a copy of the following packages from the Zope X3 Milestone 2 |
| release, and will install them unless Zope X3 is available on 'sys.path' |
release, and will install them unless Zope X3 is available on 'sys.path' |
| at the time 'setup.py' is run: |
at the time 'setup.py' is run: |
| |
|
| - 'zope.interface' |
|
| |
|
| - 'persistence' |
- 'persistence' |
| |
|
| - 'ZConfig' |
- 'ZConfig' |
| will not install any of the Zope packages listed above, in order to avoid |
will not install any of the Zope packages listed above, in order to avoid |
| overwriting newer versions from your Zope installation. |
overwriting newer versions from your Zope installation. |
| |
|
| The 'zope.interface', 'persistence', and 'ZConfig' packages are |
The 'persistence' and 'ZConfig' packages are Copyright Zope Corporation |
| Copyright Zope Corporation and contributors; please see the 'LICENSE.txt' |
and contributors; please see the 'LICENSE.txt' files in their directories |
| files in their directories for details of their licenses. |
for details of their licenses. |
| |
|
| |
|
| The 'fcgiapp' Module |
The 'fcgiapp' Module |
| |
|
| |
|
| |
|
| |
|
| TESTING YOUR INSTALLATION |
|
| |
|
| PEAK comes with a moderately-sized built-in test suite. If you wish to |
|
| run it after installation, you can do so like this:: |
|
| |
|
| python setup.py test |
|
| |
|
| This will run over 120 tests on various parts of PEAK. If you have |
|
| installed everything correctly, 100% of the tests should succeed. If |
|
| anything is broken, you will probably be unable to run the tests at all. |
|
| |
|
| If you'd like to run only a portion of the test suite, you can supply |
|
| the '--test-module' or '-m' option to the test command as follows:: |
|
| |
|
| python setup.py test --test-module=peak.util.tests |
|
| |
|
| python setup.py test -m peak.tests |
|
| |
|
| And so on. You can also use 'python setup.py -q test' to make the tests |
|
| run more "quietly". |
|
| |
|
| |
|
| |
|
| |
|
| EMBEDDING PEAK IN AN APPLICATION |
EMBEDDING PEAK IN AN APPLICATION |
| |
|
| If you are embedding PEAK in an application that you are distributing, |
If you are embedding PEAK in an application that you are distributing, |
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
Diff of /PEAK/INSTALL.txt
Parent Directory
| 
Revision Log