| | |
|---|
| | | ========================= |
|---|
| | | |
|---|
| | | :app:`Pyramid` is a small, fast, down-to-earth Python web framework. It is |
|---|
| | | developed as part of the `Pylons Project <http://docs.pylonsproject.org/>`_. |
|---|
| | | developed as part of the `Pylons Project <https://pylonsproject.org>`_. |
|---|
| | | It is licensed under a `BSD-like license <http://repoze.org/license.html>`_. |
|---|
| | | |
|---|
| | | Here is one of the simplest :app:`Pyramid` applications you can make: |
|---|
| | |
|---|
| | | .. literalinclude:: narr/helloworld.py |
|---|
| | | |
|---|
| | | After you install :app:`Pyramid` and run this application, when you visit |
|---|
| | | `<http://localhost:8080/hello/world>`_ in a browser, you will see the text |
|---|
| | | ``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how |
|---|
| | | `<http://localhost:6543/>`_ in a browser, you will see the text |
|---|
| | | ``Hello World!`` See :ref:`firstapp_chapter` for a full explanation of how |
|---|
| | | this application works. |
|---|
| | | |
|---|
| | | |
|---|
| | | .. _html_getting_started: |
|---|
| | | .. _getting_started: |
|---|
| | | |
|---|
| | | Getting Started |
|---|
| | | =============== |
|---|
| | |
|---|
| | | * :doc:`quick_tour` gives an overview of the major features in Pyramid, |
|---|
| | | covering a little about a lot. |
|---|
| | | |
|---|
| | | * :doc:`quick_tutorial/index` is similar to the Quick Tour, but in a tutorial |
|---|
| | | format, with somewhat deeper treatment of each topic and with working code. |
|---|
| | | |
|---|
| | | * Like learning by example? Visit the official :ref:`html_tutorials` as well as |
|---|
| | | the community-contributed :ref:`Pyramid tutorials |
|---|
| | | <tutorials:pyramid-tutorials>`, which include a :ref:`Todo List Application |
|---|
| | | in One File <tutorials:single-file-tutorial>`. |
|---|
| | | the community-contributed :ref:`Pyramid Tutorials |
|---|
| | | <tutorials:pyramid-tutorials>` and :ref:`Pyramid Community Cookbook |
|---|
| | | <cookbook:pyramid-cookbook>`. |
|---|
| | | |
|---|
| | | * For help getting Pyramid set up, try :ref:`installing_chapter`. |
|---|
| | | |
|---|
| | |
|---|
| | | Tutorials |
|---|
| | | ========= |
|---|
| | | |
|---|
| | | Official tutorials explaining how to use :app:`Pyramid` to build various types |
|---|
| | | of applications, and how to deploy :app:`Pyramid` applications to various |
|---|
| | | platforms. |
|---|
| | | Official tutorials provide a quick overview of :app:`Pyramid`'s features in more depth than the Quick Tour and with working code, explain how to use :app:`Pyramid` to build various types of applications, and how to deploy :app:`Pyramid` applications to various platforms. |
|---|
| | | |
|---|
| | | .. toctree:: |
|---|
| | | :maxdepth: 1 |
|---|
| | | |
|---|
| | | tutorials/wiki2/index.rst |
|---|
| | | tutorials/wiki/index.rst |
|---|
| | | tutorials/modwsgi/index.rst |
|---|
| | | quick_tutorial/index |
|---|
| | | tutorials/wiki2/index |
|---|
| | | tutorials/wiki/index |
|---|
| | | tutorials/modwsgi/index |
|---|
| | | |
|---|
| | | |
|---|
| | | .. _support-and-development: |
|---|
| | |
|---|
| | | Support and Development |
|---|
| | | ======================= |
|---|
| | | |
|---|
| | | The `Pylons Project web site <http://pylonsproject.org/>`_ is the main online |
|---|
| | | source of :app:`Pyramid` support and development information. |
|---|
| | | The `Pyramid website <https://trypyramid.com/documentation.html>`_ is the main |
|---|
| | | entry point to :app:`Pyramid` web framework resources for support and |
|---|
| | | development information. |
|---|
| | | |
|---|
| | | To report bugs, use the `issue tracker |
|---|
| | | <https://github.com/Pylons/pyramid/issues>`_. |
|---|
| | | |
|---|
| | | If you've got questions that aren't answered by this documentation, contact the |
|---|
| | | `Pylons-discuss maillist <http://groups.google.com/group/pylons-discuss>`_ or |
|---|
| | | join the `#pyramid IRC channel <irc://irc.freenode.net/#pyramid>`_. |
|---|
| | | `Pylons-discuss maillist |
|---|
| | | <https://groups.google.com/forum/#!forum/pylons-discuss>`_ or join the |
|---|
| | | `#pyramid IRC channel |
|---|
| | | <https://webchat.freenode.net/?channels=pyramid>`_. |
|---|
| | | |
|---|
| | | Browse and check out tagged and trunk versions of :app:`Pyramid` via the |
|---|
| | | `Pyramid GitHub repository <https://github.com/Pylons/pyramid/>`_. To check out |
|---|
| | | the trunk via ``git``, use this command: |
|---|
| | | the trunk via ``git``, use either command: |
|---|
| | | |
|---|
| | | .. code-block:: text |
|---|
| | | |
|---|
| | | git clone git@github.com:Pylons/pyramid.git |
|---|
| | | # If you have SSH keys configured on GitHub: |
|---|
| | | git clone git@github.com:Pylons/pyramid.git |
|---|
| | | |
|---|
| | | To find out how to become a contributor to :app:`Pyramid`, please see the |
|---|
| | | `contributor's section of the documentation |
|---|
| | | <http://docs.pylonsproject.org/en/latest/#contributing>`_. |
|---|
| | | # Otherwise, HTTPS will work, using your GitHub login: |
|---|
| | | git clone https://github.com/Pylons/pyramid.git |
|---|
| | | |
|---|
| | | To find out how to become a contributor to :app:`Pyramid`, please see `How to Contribute Source Code and Documentation <https://pylonsproject.org/community-how-to-contribute.html>`_. |
|---|
| | | |
|---|
| | | |
|---|
| | | .. _html_narrative_documentation: |
|---|
| | |
|---|
| | | narr/extending |
|---|
| | | narr/advconfig |
|---|
| | | narr/extconfig |
|---|
| | | narr/cookiecutters |
|---|
| | | narr/scaffolding |
|---|
| | | narr/upgrading |
|---|
| | | narr/threadlocals |
|---|
| | |
|---|
| | | api/* |
|---|
| | | |
|---|
| | | |
|---|
| | | ``p*`` Scripts Documentation |
|---|
| | | ============================ |
|---|
| | | |
|---|
| | | ``p*`` scripts included with :app:`Pyramid`. |
|---|
| | | |
|---|
| | | .. toctree:: |
|---|
| | | :maxdepth: 1 |
|---|
| | | :glob: |
|---|
| | | |
|---|
| | | pscripts/index |
|---|
| | | pscripts/* |
|---|
| | | |
|---|
| | | |
|---|
| | | Change History |
|---|
| | | ============== |
|---|
| | | |
|---|
| | | .. toctree:: |
|---|
| | | :maxdepth: 1 |
|---|
| | | |
|---|
| | | whatsnew-1.10 |
|---|
| | | whatsnew-1.9 |
|---|
| | | whatsnew-1.8 |
|---|
| | | whatsnew-1.7 |
|---|
| | | whatsnew-1.6 |
|---|
| | | whatsnew-1.5 |
|---|
| | | whatsnew-1.4 |
|---|
| | |
|---|
| | | copyright |
|---|
| | | |
|---|
| | | |
|---|
| | | Typographical Conventions |
|---|
| | | ========================= |
|---|
| | | Typographical Conventions and Style Guide |
|---|
| | | ========================================= |
|---|
| | | |
|---|
| | | .. toctree:: |
|---|
| | | :maxdepth: 1 |
|---|
| | | |
|---|
| | | conventions |
|---|
| | | typographical-conventions |
|---|
| | | |
|---|
| | | |
|---|
| | | Index and Glossary |
|---|
