Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 86 lines (57 sloc) 1.777 kB
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
1 pyramid_zcml
2 ============
3
4 Overview
5 --------
6
04042d1 @mcdonc get docs right
mcdonc authored
7 ``pyramid_zcml`` is a package which provides :term:`ZCML` directives for all
8 built-in Pyramid configurator methods.
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
9
10 Installation
11 ------------
12
13 Install using setuptools, e.g. (within a virtualenv)::
14
15 $ easy_install pyramid_zcml
16
17 Setup
18 -----
19
20 Once ``pyramid_zcml`` is installed, you must use the ``config.include``
21 mechanism to include it into your Pyramid project's configuration. In your
22 Pyramid project's ``__init__.py``:
23
24 .. code-block:: python
25 :linenos:
26
27 import pyramid_zcml
28
29 config = Configurator(.....)
30 config.include(pyramid_zcml)
31
04042d1 @mcdonc get docs right
mcdonc authored
32 Do this before trying to load any ZCML. After this step is taken, it will be
33 possible to use the :func:`pyramid_zcml.load_zcml` function as a method of
34 the configurator, ala:
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
35
36 .. code-block:: python
37 :linenos:
38
39 config.load_zcml(....)
40
fd6630e @mcdonc explain paster templates
mcdonc authored
41 Paster Template
42 ---------------
43
44 The ``pyramid_starter_zcml`` Paster template is included with this package.
a75fa79 @mcdonc add note about pcreate
mcdonc authored
45 You can use it via ``paster create -t pyramid_starter_zcml`` (on Pyramid 1.0,
46 1.1, or 1.2) or ``pcreate -s pyramid_starter_zcml`` (on Pyramid 1.3). It
47 creates a package skeleton which configures a Pyramid appliction via ZCML.
48 The application performs URL mapping via :term:`traversal` and no persistence
fd6630e @mcdonc explain paster templates
mcdonc authored
49 mechanism.
50
9389e5f @mcdonc - Add paster template for starter_zcml
mcdonc authored
51 Usage
52 -----
53
54 .. toctree::
55 :maxdepth: 2
56
57 narr.rst
58
59
04042d1 @mcdonc get docs right
mcdonc authored
60 Directives and API
61 ------------------
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
62
63 .. toctree::
04042d1 @mcdonc get docs right
mcdonc authored
64 :maxdepth: 2
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
65
04042d1 @mcdonc get docs right
mcdonc authored
66 zcml.rst
5046ea4 @mcdonc first cut (one test still fails)
mcdonc authored
67 api.rst
68 glossary.rst
69
70
71 Reporting Bugs / Development Versions
72 -------------------------------------
73
74 Visit http://github.com/Pylons/pyramid_zcml to download development or
75 tagged versions.
76
77 Visit http://github.com/Pylons/pyramid_zcml/issues to report bugs.
78
79 Indices and tables
80 ------------------
81
82 * :ref:`glossary`
83 * :ref:`genindex`
84 * :ref:`modindex`
85 * :ref:`search`
Something went wrong with that request. Please try again.