|
1 .. _introduction: |
|
2 |
|
3 Welcome to PyAMS's documentation! |
|
4 ================================= |
|
5 |
|
6 .. warning:: |
|
7 This is a "work-in-progress" documentation. All elements described here are not publicly available yet. |
|
8 |
|
9 |
|
10 What is PyAMS? |
|
11 -------------- |
|
12 |
|
13 **PyAMS** stands for **Py**\ramid **\A**\pplication **\M**\anagement **\S**\kin is a whole "Suite" of |
|
14 applications and content management tools with user friendly skin. |
|
15 |
|
16 |
|
17 What is Pyramid? |
|
18 ---------------- |
|
19 |
|
20 Pyramid is an open source Python web application framework. It is designed to make creating web applications easier. |
|
21 |
|
22 |
|
23 Why should i use PyAMS? |
|
24 ----------------------- |
|
25 |
|
26 Based on the python langage, **PyAMS** supply powerfull tools like *PyAMS_content*, this package |
|
27 providing content management features, which can be easily extended to manage your own content types. |
|
28 But PyAMS can also be used to manage any kind of application. |
|
29 |
|
30 In addition **PyAMS** is built on top of **MyAMS** (**My** **\A**\pplication **\M**\anagement **\S**\kin), a small web client framework built on top of JQuery |
|
31 and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts -- |
|
32 http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website |
|
33 is now completely handled with PyAMS framework. |
|
34 |
|
35 PyAMS is a multipurpose set of packages, providing tools including: |
|
36 |
|
37 * custom interfaces |
|
38 * custom registry annotations |
|
39 * custom security policy |
|
40 * local registry support |
|
41 * network protocols utilities (for HTTP and XML-RPC) |
|
42 * command line scripts |
|
43 * custom utilities. |
|
44 |
|
45 |
|
46 .. tip:: |
|
47 Some screenshots of the admin interface are available at :ref:`screenshots`! |
|
48 |
|
49 |
|
50 How to install PyAMS? |
|
51 --------------------- |
|
52 |
|
53 If you want to create a PyAMS application instance easily, just follow the :ref:`quickstart` guide! |
|
54 If you want learn more about a custom installation follow :ref:`install` procedure. |
|
55 |
|
56 |
|
57 |
|
58 1.1. Overview |
|
59 |
|
60 Zope 2 is a free and open-source, object-oriented web application server written in the Python programming language. The term ZOPE is an acronym for “Z Object Publishing Environment” (the Z doesn’t really mean anything in particular). However, nowadays ZOPE is simply written as Zope. It has three distinct audiences. |
|
61 |
|
62 |
|
63 Developers |
|
64 Individuals who wish to extend Zope to create highly customized solutions. This audience is likely interested in creating highly reusable custom code that makes Zope do something new and interesting. They will likely make heavy use of “through the file-system” style development. |
|
65 |
|
66 |
|
67 This guide is intended to document Zope for the second audience, Developers, as defined above. If you fit more into the “user” audience defined above, you’ll probably want to start by reading The Zope Book . |
|
68 |
|
69 Throughout this guide, it is assumed that you know how to program in the Python programming language. Most of the examples in this guide will be in Python. There are a number of great resources and books for learning Python; the best online resource is the python.org web site and many books can be found on the shelves of your local bookstore. |
|
70 1.2. Organization of the book |
|
71 |
|
72 This book describes Zope’s services to the developer from a hands on, example-oriented standpoint. This book is not a complete reference to the Zope API, but rather a practical guide to applying Zope’s services to develop and deploy your own web applications. This book covers the following topics: |
|
73 |
|
74 Getting Started |
|
75 This chapter provides a brief overview of installation and getting started with application development. |
|
76 Components and Interfaces |
|
77 Zope use a component-centric development model. This chapter describes the component model in Zope and how Zope components are described through interfaces. |
|
78 Object Publishing |
|
79 Developing applications for Zope involves more than just creating a component, that component must be publishable on the web. This chapter describes publication, and how your components need to be designed to be published. |
|
80 Zope Products |
|
81 New Zope components are distributed and installed in packages called “Products”. This chapter explains Products in detail. |
|
82 Persistent Components |
|
83 Zope provides a built-in, transparent Python object database called ZODB. This chapter describes how to create persistent components, and how they work in conjunction with the ZODB. |
|
84 Acquisition |
|
85 Zope relies heavily on a dynamic technique called acquisition. This chapter explores acquisition thoroughly. |
|
86 Security |
|
87 When your component is used by many different people through the web, security becomes a big concern. This chapter describes Zope’s security API and how you can use it to make security assertions about your object. |
|
88 Debugging and Testing |
|
89 Zope has built in debugging and testing support. This chapter describes these facilities and how you can debug and test your components. |
|
90 |