Permalink
Browse files

extracted quick tutorial

  • Loading branch information...
1 parent 1071dec commit 458aa21becbfc823b12386fc68ed9eb513953995 @blaflamme blaflamme committed Nov 24, 2011
Showing with 0 additions and 309 deletions.
  1. +0 −56 libraries.rst
  2. +0 −14 pylons.rst
  3. +0 −179 pyramid.rst
  4. +0 −60 pyramid_install.rst
View
56 libraries.rst
@@ -1,56 +0,0 @@
-Library Package Documentation
-=============================
-
-The following packages are hosted within the Pylons Project GitHub
-organization repository structure, and are officially endorsed, but are not
-Pyramid add-ons.
-
-* `WebOb <http://webob.org>`_, WSGI request/response library
-
- - Maintained by: Sergey Schetenin
-
- - Version Control: https://github.com/Pylons/webob
-
-* `colander </projects/colander/en/latest/>`_,
- serialization/deserialization/validation library.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/colander
-
-* `deform </projects/deform/en/latest/>`_: an HTML form library.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/deform
-
-* `peppercorn </projects/peppercorn/en/latest/>`_, A library for converting a token
- stream into a data structure comprised of sequences, mappings, and scalars,
- developed primarily for converting HTTP form post data into a richer data
- structure.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/peppercorn
-
-* `translationstring </projects/translationstring/en/latest/>`_, an
- internationalization library used by various Pylons Project software.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/translationstring
-
-* `venusian </projects/venusian/en/latest/>`_, a library useful for
- framework authors to defer decorator actions.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/venusian
-
-* `webhelpers </projects/webhelpers/en/latest/>`_, a library for
- python web helpers.
-
- - Maintained by: Ben Bangert, Mike Orr
-
- - Version Control: https://bitbucket.org/bbangert/webhelpers
-
View
14 pylons.rst
@@ -1,14 +0,0 @@
-Pylons Documentation
-=====================
-
-Main Documentation Sources
---------------------------
-
-* `Pylons documentation 1.0 </projects/pylons-webframework/en/latest/>`_: official
- Pylons documentation.
-
-* `Pylons wiki <http://wiki.pylonshq.com/dashboard.action>`_:
- user-contributed Pylons documentation.
-
-* `Definitive Guide to Pylons <http://pylonsbook.com/>`_: Pylons book
- published by Apress, written by James Gardner, free HTML rendering.
View
179 pyramid.rst
@@ -1,179 +0,0 @@
-Pyramid Documentation
-=====================
-
-Getting Started
----------------
-
-If you are new to Pyramid, we have a few resources that can help you get up to
-speed right away:
-
-* Check out our `FAQ </faq/pyramid.html>`_.
-
-* For help getting Pyramid set up, try the `install guide
- <pyramid_install.html>`_.
-
-* Coming from Pylons? Start with :ref:`Akhet <akhet-desc>`.
-
-* To get the feel of how a Pyramid web application is created, go to the
- `quick tutorial <pyramid_quick_tutorial.html>`_ page.
-
-* Like learning by example? Check out to the `wiki tutorial
- </projects/pyramid/en/1.2-branch/tutorials/wiki2/index.html>`_.
-
-* Need help? See :ref:`support-desc`.
-
-Main Documentation
-------------------
-
-* `Pyramid documentation 1.2 </projects/pyramid/en/1.2-branch/>`_ (`1.2 PDF
- <http://media.readthedocs.org/pdf/pyramid/1.2-branch/pyramid.pdf>`_) (`1.2 Epub
- <http://media.readthedocs.org/epub/pyramid/1.2-branch/pyramid.epub>`_) - narrative and API
- documentation for Pyramid's current stable release.
-
-* `Pyramid documentation 1.1 </projects/pyramid/en/1.1-branch/>`_ (`1.1 PDF
- <http://media.readthedocs.org/pdf/pyramid/1.1-branch/pyramid.pdf>`_) (`1.1 Epub
- <http://media.readthedocs.org/epub/pyramid/1.1-branch/pyramid.epub>`_) - narrative and API
- documentation for Pyramid's 1.1 version.
-
-* `Pyramid documentation 1.0 </projects/pyramid/en/1.0-branch/>`_ (`1.0 PDF
- <http://media.readthedocs.org/pdf/pyramid/1.0-branch/pyramid.pdf>`_) (`1.0 Epub
- <http://media.readthedocs.org/epub/pyramid/1.0-branch/pyramid.epub>`_) - narrative and API
- documentation for Pyramid's 1.0 version.
-
-* `Pyramid development documentation </projects/pyramid/en/latest/>`_ - narrative
- and API documentation for Pyramid's unreleased in-development version.
-
-* `The Pyramid Cookbook
- </projects/pyramid_cookbook/en/latest/>`_ presents
- topical, practical usages of Pyramid. The cookbook is unfinished.
-
-Pyramid Add-On Documentation
-----------------------------
-
-Pyramid supports extensibility through add-ons. The following add-ons are
-officially endorsed by the Pylons Project, and their documentation is hosted
-here.
-
-* `pyramid_beaker </projects/pyramid_beaker/en/latest/>`_: Beaker session backend
- plug-in.
-
- - Maintained by: Ben Bangert, Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_beaker
-
-* `pyramid_chameleon_genshi </projects/pyramid_chameleon_genshi/en/latest/>`_:
- template renderer for `Chameleon's Genshi implementation
- <http://chameleon.repoze.org/docs/latest/genshi.html>`_.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_chameleon_genshi
-
-* `pyramid_debugtoolbar </projects/pyramid_debugtoolbar/en/latest/>`_, an interactive
- HTML debug toolbar for Pyramid.
-
- - Maintained by: Chris McDonough, Blaise Laflamme
-
- - Version Control: https://github.com/Pylons/pyramid_debugtoolbar
-
-* `pyramid_exclog </projects/pyramid_exclog/en/latest/>`_, a package which logs
- exceptions from Pyramid applications.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_exclog
-
-* `pyramid_handlers </projects/pyramid_handlers/en/latest/>`_: analogue of
- Pylons-style "controllers" for Pyramid.
-
- - Maintained by: Ben Bangert, Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_handlers
-
-* `pyramid_jinja2 </projects/pyramid_jinja2/en/latest/>`_: `Jinja2
- <http://jinja.pocoo.org/>`_ template renderer for Pyramid
-
- - Maintained by: Rocky Burt
-
- - Version Control: https://github.com/Pylons/pyramid_jinja2
-
-* `pyramid_jqm </projects/pyramid_jqm/en/latest/>`_, scaffolding for developing
- jQuery Mobile apps with Pyramid.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_jqm
-
-* `pyramid_mailer </projects/pyramid_mailer/en/latest/>`_: a package for the
- Pyramid framework to take the pain out of sending emails.
-
- - Maintained by: Dan Jacobs, Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_mailer
-
-* `pyramid_rpc </projects/pyramid_rpc/en/latest/>`_: RPC service add-on for
- Pyramid, supports XML-RPC in a more extensible manner than `pyramid_xmlrpc`
- with support for JSON-RPC and AMF.
-
- - Maintained by: Ben Bangert
-
- - Version Control: https://github.com/Pylons/pyramid_rpc
-
-* `pyramid_tm </projects/pyramid_tm/en/latest/>`_: Centralized transaction
- management for Pyramid applications (without middleware).
-
- - Maintained by: Rocky Burt
-
- - Version Control: https://github.com/Pylons/pyramid_tm
-
-* `pyramid_who </projects/pyramid_who/en/latest/>`_: Authentication policy for
- pyramid using repoze.who 2.0 API.
-
- - Maintained by: Chris McDonough, Tres Seaver
-
- - Version Control: https://github.com/Pylons/pyramid_who
-
-* `pyramid_xmlrpc </projects/pyramid_xmlrpc/en/latest/>`_: XML-RPC add-on for
- Pyramid
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_xmlrpc
-
-* `pyramid_zcml </projects/pyramid_zcml/en/latest/>`_: Zope Configuration Markup
- Language configuration support for Pyramid.
-
- - Maintained by: Chris McDonough
-
- - Version Control: https://github.com/Pylons/pyramid_zcml
-
-Pyramid Development Environment Documentation
----------------------------------------------
-
-Development environments are packages which use Pyramid as a core, but offer
-alternate services and scaffolding. Each development environment presents a
-set of opinions and a "personality" to its users. Although users of a
-development environment can still use all of the services offered by the
-Pyramid core, they are usually guided to a more focused set of opinions
-offered by the development environment itself. Development environments
-often have dependencies beyond those of the Pyramid core.
-
-.. _akhet-desc:
-
-* `Akhet </projects/akhet/en/latest/>`_: Akhet is an application scaffolding for
- Pyramid that's closer to the Pylons 1 style than Pyramid's built-in
- scaffolding. The manual also tries to be a gentler introduction to Pyramid
- for those from a Pylons-ish background.
-
- - Maintained by: Mike Orr
-
- - Version Control: https://bitbucket.org/sluggo/akhet
-
-* `Khufu Project <http://khufuproject.github.com/>`_: Khufu is an application
- scaffolding for Pyramid that provides an environment to work with Jinja2 and
- SQLAlchemy.
-
- - Maintained by: Rocky Burt
-
- - Version Control: https://github.com/khufuproject
-
View
60 pyramid_install.rst
@@ -1,60 +0,0 @@
-Installing Pyramid
-=========================
-
-This is a quick guide to getting Pyramid set up, it should be good enough
-for most use cases. If you run into some problem and need more detailed help
-or if you are using a different platform, please consult our
-`detailed installation guide
-<http://docs.pylonsproject.org/projects/pyramid/1.0/narr/install.html>`_.
-
-Before You Install
-------------------
-
-You will need Python version 2.4 or better to
-run Pyramid. Pyramid doesn't run on Python 3 yet, but we're working
-on it. `Get Python now <http://www.python.org/download/>`_.
-
-Pyramid is known to run on all popular Unix-like systems such as
-Linux, MacOS X, and FreeBSD as well as on Windows platforms. It is also
-known to run on Google's App Engine and :term:`Jython`.
-
-It is best practice to install Pyramid into a "virtual"
-Python environment in order to obtain isolation from any "system"
-packages you've got installed in your Python version. This can be
-done by using the :term:`virtualenv` package. Using a virtualenv will
-also prevent Pyramid from globally installing versions of
-packages that are not compatible with your system Python.
-
-To install virtualenv you will need setuptools. Once you've got
-setuptools installed, you should install the :term:`virtualenv` package
-using the ``easy_install`` command.
-
-.. code-block:: text
-
- $ easy_install virtualenv
-
-
-Installing Pyramid Into the Virtual Python Environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-After you've got your ``env`` virtualenv installed, you may install
-Pyramid itself using the following commands from within the
-virtualenv (``env``) directory:
-
-.. code-block:: text
-
- $ bin/easy_install pyramid
-
-This command will take longer than the previous ones to complete, as it
-downloads and installs a number of dependencies.
-
-What Gets Installed
--------------------
-
-When you ``easy_install`` Pyramid, various Zope libraries,
-various Chameleon libraries, WebOb, Paste, PasteScript, and
-PasteDeploy libraries are installed.
-
-Additionally, as chronicled in :ref:`project_narr`, PasteScript (aka
-*paster*) templates will be registered that make it easy to start a
-new Pyramid project.

0 comments on commit 458aa21

Please sign in to comment.