diff options
| author | Michael Merickel <michael@merickel.org> | 2017-01-02 19:22:28 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-01-02 19:22:28 -0600 |
| commit | f01e74d21e7cadd052c1853d7fe482bd7b9970fa (patch) | |
| tree | abcec287bda4b706bfa3e6bc40601d0883206122 /docs/quick_tutorial/scaffolds.rst | |
| parent | fc163d411bd57b232f68ed6554aff3a3ef8f2339 (diff) | |
| parent | a36d33bf7872575fb79cdc0e5959a62b30df5742 (diff) | |
| download | pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.gz pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.bz2 pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.zip | |
Merge pull request #2889 from stevepiercy/docs-cookiecutter-changes-only
Docs cookiecutter changes only - Quick Tutorial and all other files
Diffstat (limited to 'docs/quick_tutorial/scaffolds.rst')
| -rw-r--r-- | docs/quick_tutorial/scaffolds.rst | 87 |
1 files changed, 0 insertions, 87 deletions
diff --git a/docs/quick_tutorial/scaffolds.rst b/docs/quick_tutorial/scaffolds.rst deleted file mode 100644 index 8712d64e9..000000000 --- a/docs/quick_tutorial/scaffolds.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. _qtut_cookiecutters: - -============================================= -Prelude: Quick Project Startup with Scaffolds -============================================= - -To ease the process of getting started, Pyramid provides *scaffolds* that -generate sample projects from templates in Pyramid and Pyramid add-ons. - - -Background -========== - -We're going to cover a lot in this tutorial, focusing on one topic at a time -and writing everything from scratch. As a warm up, though, it sure would be -nice to see some pixels on a screen. - -Like other web development frameworks, Pyramid provides a number of "scaffolds" -that generate working Python, template, and CSS code for sample applications. -In this step we'll use a built-in scaffold to let us preview a Pyramid -application, before starting from scratch on Step 1. - - -Objectives -========== - -- Use Pyramid's ``pcreate`` command to list scaffolds and make a new project. - -- Start up a Pyramid application and visit it in a web browser. - - -Steps -===== - -#. Pyramid's ``pcreate`` command can list the available scaffolds: - - .. code-block:: bash - - $ $VENV/bin/pcreate --list - Available scaffolds: - alchemy: Pyramid project using SQLAlchemy, SQLite, URL dispatch, and Jinja2 - starter: Pyramid starter project using URL dispatch and Chameleon - zodb: Pyramid project using ZODB, traversal, and Chameleon - -#. Tell ``pcreate`` to use the ``starter`` scaffold to make our project: - - .. code-block:: bash - - $ $VENV/bin/pcreate --scaffold starter scaffolds - -#. Install our project in editable mode for development in the current - directory: - - .. code-block:: bash - - $ cd scaffolds - $ $VENV/bin/pip install -e . - -#. Start up the application by pointing Pyramid's ``pserve`` command at the - project's (generated) configuration file: - - .. code-block:: bash - - $ $VENV/bin/pserve development.ini --reload - - On start up, ``pserve`` logs some output: - - .. code-block:: bash - - Starting subprocess with file monitor - Starting server in PID 72213. - Starting HTTP server on http://0.0.0.0:6543 - -#. Open http://localhost:6543/ in your browser. - -Analysis -======== - -Rather than starting from scratch, ``pcreate`` can make getting a Python -project containing a Pyramid application a quick matter. Pyramid ships with a -few scaffolds. But installing a Pyramid add-on can give you new scaffolds from -that add-on. - -``pserve`` is Pyramid's application runner, separating operational details from -your code. When you install Pyramid, a small command program called ``pserve`` -is written to your ``bin`` directory. This program is an executable Python -module. It is passed a configuration file (in this case, ``development.ini``). |
