1 .. PyAMS_utils documentation master file, created by |
1 .. PyAMS documentation master file, created by |
2 sphinx-quickstart on Tue Nov 15 16:18:42 2016. |
2 sphinx-quickstart on Tue Nov 15 16:18:42 2016. |
3 You can adapt this file completely to your liking, but it should at least |
3 You can adapt this file completely to your liking, but it should at least |
4 contain the root `toctree` directive. |
4 contain the root `toctree` directive. |
5 |
5 |
6 .. _index: |
6 .. _index: |
7 |
7 |
8 |
8 |
9 **WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!! |
9 **WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!! |
10 |
10 |
11 |
11 |
12 Welcome to PyAMS_utils's documentation! |
12 Welcome to PyAMS's documentation! |
13 ======================================= |
13 ================================= |
14 |
14 |
15 At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of |
15 At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of |
16 applications and content management tools. |
16 applications and content management tools. |
17 |
17 |
18 PyAMS_utils is a multipurpose utilities package, providing tools including: |
18 PyAMS is a multipurpose set of packages, providing tools including: |
19 |
19 |
20 * custom interfaces |
20 * custom interfaces |
21 * custom ZCA registry annotations |
21 * custom ZCA registry annotations |
22 * local registry support |
22 * local registry support |
23 * network protocols utilities (for HTTP and XML-RPC) |
23 * network protocols utilities (for HTTP and XML-RPC) |
24 * custom utilities |
24 * command line scripts |
25 * a command line script to handle database upgrade process |
25 * a custom security policy |
|
26 * custom utilities... |
|
27 |
|
28 If you just want to know how easy it is to create a PyAMS application instance, just read the :ref:`quickstart`! |
26 |
29 |
27 |
30 |
28 .. toctree:: |
31 .. toctree:: |
29 :maxdepth: 2 |
32 :maxdepth: 2 |
30 |
33 |
|
34 quickstart |
|
35 architecture |
31 zodb |
36 zodb |
32 install |
37 install |
33 zca |
38 zca |
34 site |
39 site |
35 traverser |
40 traverser |
50 |
55 |
51 * a Redis or Memcached server, to handle cache and sessions; |
56 * a Redis or Memcached server, to handle cache and sessions; |
52 |
57 |
53 * an Elasticsearch index, used to handle quick and optimized searching. |
58 * an Elasticsearch index, used to handle quick and optimized searching. |
54 |
59 |
|
60 See :ref:`architecture` to get all architecture details. |
|
61 |
55 |
62 |
56 PyAMS external packages |
63 PyAMS external packages |
57 ----------------------- |
64 ----------------------- |
58 |
65 |
59 PyAMS is built on many external packages, and provides a whole set of extensions. He re is a list of them: |
66 PyAMS is built on many external packages, and provides a whole set of extensions. Here is a list of them: |
60 |
67 |
61 * pyams_template (:ref:`pyams_template`) |
68 * pyams_template (:ref:`pyams_template`) |
62 |
69 |
63 * pyams_viewlet (:ref:`pyams_viewlet`) |
70 * pyams_viewlet (:ref:`pyams_viewlet`) |
64 |
71 |