Skip to content

Commit

Permalink
Simplify readme and docs.
Browse files Browse the repository at this point in the history
Also drop zope.untrustedpython as much as possible.
  • Loading branch information
hannosch committed Sep 29, 2016
1 parent 185f439 commit a7591db
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 196 deletions.
134 changes: 0 additions & 134 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,137 +16,3 @@ dependencies) and can directly be used with a buildout by specifying the
``ztk-versions.cfg`` file via the ``extends`` mechanism.

To test the ZTK, run ``bin/test-ztk``.

For details about the ZTK, please see http://docs.zope.org/zopetoolkit.

Included Repositories
---------------------

The following repositories are managed under the ZTK umbrella project:

- `zope.annotation <https://github.com/zopefoundation/zope.annotation>`_

- `zope.applicationcontrol <https://github.com/zopefoundation/zope.applicationcontrol>`_

- `zope.authentication <https://github.com/zopefoundation/zope.authentication>`_

- `zope.browser <https://github.com/zopefoundation/zope.browser>`_

- `zope.browsermenu <https://github.com/zopefoundation/zope.browsermenu>`_

- `zope.browserpage <https://github.com/zopefoundation/zope.browserpage>`_

- `zope.browserresource <https://github.com/zopefoundation/zope.browserresource>`_

- `zope.cachedescriptors <https://github.com/zopefoundation/zope.cachedescriptors>`_

- `zope.catalog <https://github.com/zopefoundation/zope.catalog>`_

- `zope.component <https://github.com/zopefoundation/zope.component>`_

- `zope.componentvocabulary <https://github.com/zopefoundation/zope.componentvocabulary>`_

- `zope.configuration <https://github.com/zopefoundation/zope.configuration>`_

- `zope.container <https://github.com/zopefoundation/zope.container>`_

- `zope.contentprovider <https://github.com/zopefoundation/zope.contentprovider>`_

- `zope.contenttype <https://github.com/zopefoundation/zope.contenttype>`_

- `zope.copy <https://github.com/zopefoundation/zope.copy>`_

- `zope.copypastemove <https://github.com/zopefoundation/zope.copypastemove>`_

- `zope.datetime <https://github.com/zopefoundation/zope.datetime>`_

- `zope.deferredimport <https://github.com/zopefoundation/zope.deferredimport>`_

- `zope.deprecation <https://github.com/zopefoundation/zope.deprecation>`_

- `zope.dottedname <https://github.com/zopefoundation/zope.dottedname>`_

- `zope.dublincore <https://github.com/zopefoundation/zope.dublincore>`_

- `zope.error <https://github.com/zopefoundation/zope.error>`_

- `zope.event <https://github.com/zopefoundation/zope.event>`_

- `zope.exceptions <https://github.com/zopefoundation/zope.exceptions>`_

- `zope.filerepresentation <https://github.com/zopefoundation/zope.filerepresentation>`_

- `zope.formlib <https://github.com/zopefoundation/zope.formlib>`_

- `zope.hookable <https://github.com/zopefoundation/zope.hookable>`_

- `zope.i18n <https://github.com/zopefoundation/zope.i18n>`_

- `zope.i18nmessageid <https://github.com/zopefoundation/zope.i18nmessageid>`_

- `zope.index <https://github.com/zopefoundation/zope.index>`_

- `zope.interface <https://github.com/zopefoundation/zope.interface>`_

- `zope.intid <https://github.com/zopefoundation/zope.intid>`_

- `zope.keyreference <https://github.com/zopefoundation/zope.keyreference>`_

- `zope.lifecycleevent <https://github.com/zopefoundation/zope.lifecycleevent>`_

- `zope.location <https://github.com/zopefoundation/zope.location>`_

- `zope.login <https://github.com/zopefoundation/zope.login>`_

- `zope.mimetype <https://github.com/zopefoundation/zope.mimetype>`_

- `zope.minmax <https://github.com/zopefoundation/zope.minmax>`_

- `zope.pagetemplate <https://github.com/zopefoundation/zope.pagetemplate>`_

- `zope.password <https://github.com/zopefoundation/zope.password>`_

- `zope.pluggableauth <https://github.com/zopefoundation/zope.pluggableauth>`_

- `zope.principalannotation <https://github.com/zopefoundation/zope.principalannotation>`_

- `zope.principalregistry <https://github.com/zopefoundation/zope.principalregistry>`_

- `zope.processlifetime <https://github.com/zopefoundation/zope.processlifetime>`_

- `zope.proxy <https://github.com/zopefoundation/zope.proxy>`_

- `zope.ptresource <https://github.com/zopefoundation/zope.ptresource>`_

- `zope.publisher <https://github.com/zopefoundation/zope.publisher>`_

- `zope.ramcache <https://github.com/zopefoundation/zope.ramcache>`_

- `zope.schema <https://github.com/zopefoundation/zope.schema>`_

- `zope.security <https://github.com/zopefoundation/zope.security>`_

- `zope.securitypolicy <https://github.com/zopefoundation/zope.securitypolicy>`_

- `zope.sendmail <https://github.com/zopefoundation/zope.sendmail>`_

- `zope.session <https://github.com/zopefoundation/zope.session>`_

- `zope.site <https://github.com/zopefoundation/zope.site>`_

- `zope.size <https://github.com/zopefoundation/zope.size>`_

- `zope.structuredtext <https://github.com/zopefoundation/zope.structuredtext>`_

- `zope.tal <https://github.com/zopefoundation/zope.tal>`_

- `zope.tales <https://github.com/zopefoundation/zope.tales>`_

- `zope.testing <https://github.com/zopefoundation/zope.testing>`_

- `zope.testrunner <https://github.com/zopefoundation/zope.testrunner>`_

- `zope.traversing <https://github.com/zopefoundation/zope.traversing>`_

- `zope.viewlet <https://github.com/zopefoundation/zope.viewlet>`_

3 changes: 0 additions & 3 deletions development-python2.cfg

This file was deleted.

63 changes: 10 additions & 53 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,69 +6,26 @@
Introduction
------------

The Zope Toolkit 2.0 release is the third feature release of the Zope
Toolkit. The Zope Toolkit really is just a collection of libraries
managed together by the Zope developers. We typically treat each
library independently, so you would like to look at the CHANGES.txt in
each library for updates. Here we note larger changes, especially ones
that affect multiple libraries.
The Zope Toolkit is a collection of libraries managed together by the
Zope developers. We typically treat each library independently, so you
should look at the CHANGES file in each library for updates.

Installation
------------

The Zope Toolkit cannot be installed directly except as individual
libraries (such as ``zope.component``). To install it you typically
would install a framework or application that makes use of these
libraries. Examples of such projects are BlueBream, Grok and Zope.
libraries. Examples of such projects are Grok and Zope.

If you want to use the Zope Toolkit KGS, you can use the buildout
extends mechanism (replace 2.0 by the desired version)::
If you want to use the Zope Toolkit Known-Good-Set (KGS), you should
copy the ztk-versions.cfg file into your own project and include it
in your buildout via the extends mechanism.

[buildout]
extends = http://download.zope.org/zopetoolkit/index/2.0/ztk-versions.cfg

You can also copy the file locally if you want to avoid network access.

Frameworks and applications have their own set of install instructions. You
should follow these in most cases.
Frameworks and applications have their own set of install instructions.
You should follow these in most cases.

Python versions
---------------

The ZTK 2.0 release series supports Python 2.7, 3.3 and 3.4. Some libraries
included in the ZTK support Python 3.2 and/or Python 3.5.

News
----

Python versions
~~~~~~~~~~~~~~~

Python 2.5 and Python 2.6 are no longer supported by this version of the ZTK.
Support for Python 3.3 and 3.4 has been added.

ZODB 4
~~~~~~

This ZTK version includes ZODB 4 instead of 3.10 as included in the 1.1
series. You can read more about the changes at
https://pypi.python.org/pypi/ZODB#change-history

Note that the former ZODB3 distribution has been split up into multiple
distributions. You can now separately install BTrees, persistent, ZEO and
ZODB.

zc.buildout 2
~~~~~~~~~~~~~

The buildout version has been updated to 2 from the former 1.x series. This
release requires some changes to recipes, so make sure to update all recipes to
compatible versions or check their availability first. More detailed changes
can be found at https://pypi.python.org/pypi/zc.buildout/2.1.0#change-history

Deprecated zope.app
~~~~~~~~~~~~~~~~~~~

This version of the ZTK no longer provides compatibility guarantees for any
zope.app.* libraries. Maintenance of these libraries is outside of the scope
of the ZTK and is taken up by individuals and framework developers.
The ZTK supports Python 2.7, 3.3, 3.4 and 3.5.
6 changes: 0 additions & 6 deletions ztk-python2-specifics.cfg

This file was deleted.

0 comments on commit a7591db

Please sign in to comment.