summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quick_tutorial')
-rw-r--r--docs/quick_tutorial/authentication.rst4
-rw-r--r--docs/quick_tutorial/authentication/setup.py6
-rw-r--r--docs/quick_tutorial/authorization/setup.py6
-rw-r--r--docs/quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja22
-rw-r--r--docs/quick_tutorial/cookiecutters/setup.py2
-rw-r--r--docs/quick_tutorial/databases/setup.py10
-rw-r--r--docs/quick_tutorial/forms.rst2
-rw-r--r--docs/quick_tutorial/forms/setup.py6
-rw-r--r--docs/quick_tutorial/json/setup.py4
-rw-r--r--docs/quick_tutorial/logging/setup.py4
-rw-r--r--docs/quick_tutorial/more_view_classes/setup.py4
-rw-r--r--docs/quick_tutorial/requirements.rst32
-rw-r--r--docs/quick_tutorial/retail_forms/setup.py6
-rw-r--r--docs/quick_tutorial/routing/setup.py4
-rw-r--r--docs/quick_tutorial/sessions/setup.py4
-rw-r--r--docs/quick_tutorial/static_assets/setup.py4
-rw-r--r--docs/quick_tutorial/templating/setup.py2
-rw-r--r--docs/quick_tutorial/tutorial_approach.rst18
-rw-r--r--docs/quick_tutorial/view_classes/setup.py4
19 files changed, 55 insertions, 69 deletions
diff --git a/docs/quick_tutorial/authentication.rst b/docs/quick_tutorial/authentication.rst
index 95acc33e4..529f51ddd 100644
--- a/docs/quick_tutorial/authentication.rst
+++ b/docs/quick_tutorial/authentication.rst
@@ -39,7 +39,7 @@ Steps
.. literalinclude:: authentication/setup.py
:language: python
- :emphasize-lines: 7
+ :emphasize-lines: 4
:linenos:
#. We can now install our project in development mode:
@@ -94,7 +94,7 @@ Steps
#. Click the "Log In" link.
-#. Submit the login form with the username ``editor`` and the password
+#. Submit the login form with the username ``editor`` and the password
``editor``.
#. Note that the "Log In" link has changed to "Logout".
diff --git a/docs/quick_tutorial/authentication/setup.py b/docs/quick_tutorial/authentication/setup.py
index 808a6f9a9..a5117af5a 100644
--- a/docs/quick_tutorial/authentication/setup.py
+++ b/docs/quick_tutorial/authentication/setup.py
@@ -1,10 +1,10 @@
from setuptools import setup
requires = [
+ 'bcrypt',
'pyramid',
- 'waitress',
'pyramid_chameleon',
- 'bcrypt'
+ 'waitress',
]
setup(name='tutorial',
@@ -13,4 +13,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/authorization/setup.py b/docs/quick_tutorial/authorization/setup.py
index 808a6f9a9..a5117af5a 100644
--- a/docs/quick_tutorial/authorization/setup.py
+++ b/docs/quick_tutorial/authorization/setup.py
@@ -1,10 +1,10 @@
from setuptools import setup
requires = [
+ 'bcrypt',
'pyramid',
- 'waitress',
'pyramid_chameleon',
- 'bcrypt'
+ 'waitress',
]
setup(name='tutorial',
@@ -13,4 +13,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja2 b/docs/quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja2
index 13a65ff72..90d2d106a 100644
--- a/docs/quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja2
+++ b/docs/quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja2
@@ -16,7 +16,7 @@
<!-- Custom styles for this scaffold -->
<link href="{{request.static_url('cc_starter:static/theme.css')}}" rel="stylesheet">
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!-- HTML5 shiv and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="//oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js" integrity="sha384-0s5Pv64cNZJieYFkXYOTId2HMA2Lfb6q2nAcx2n0RTLUnCAoTTsS0nKEO27XyKcY" crossorigin="anonymous"></script>
<script src="//oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js" integrity="sha384-ZoaMbDF+4LeFxg6WdScQ9nnR1QC2MIRxA1O9KWEXQwns1G8UNyIEZIQidzb0T1fo" crossorigin="anonymous"></script>
diff --git a/docs/quick_tutorial/cookiecutters/setup.py b/docs/quick_tutorial/cookiecutters/setup.py
index e47cdf8ea..0d1b3f70e 100644
--- a/docs/quick_tutorial/cookiecutters/setup.py
+++ b/docs/quick_tutorial/cookiecutters/setup.py
@@ -10,8 +10,8 @@ with open(os.path.join(here, 'CHANGES.txt')) as f:
requires = [
'pyramid',
- 'pyramid_jinja2',
'pyramid_debugtoolbar',
+ 'pyramid_jinja2',
'waitress',
]
diff --git a/docs/quick_tutorial/databases/setup.py b/docs/quick_tutorial/databases/setup.py
index 66045fd7e..13d1d6637 100644
--- a/docs/quick_tutorial/databases/setup.py
+++ b/docs/quick_tutorial/databases/setup.py
@@ -1,13 +1,13 @@
from setuptools import setup
requires = [
+ 'deform',
'pyramid',
- 'waitress',
'pyramid_chameleon',
- 'deform',
- 'sqlalchemy',
'pyramid_tm',
- 'zope.sqlalchemy'
+ 'sqlalchemy',
+ 'waitress',
+ 'zope.sqlalchemy',
]
setup(name='tutorial',
@@ -18,4 +18,4 @@ setup(name='tutorial',
[console_scripts]
initialize_tutorial_db = tutorial.initialize_db:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/forms.rst b/docs/quick_tutorial/forms.rst
index 3c865ad09..45eb05a8f 100644
--- a/docs/quick_tutorial/forms.rst
+++ b/docs/quick_tutorial/forms.rst
@@ -41,7 +41,7 @@ Steps
pulls in Colander as a dependency:
.. literalinclude:: forms/setup.py
- :emphasize-lines: 7
+ :emphasize-lines: 4
:linenos:
#. We can now install our project in development mode:
diff --git a/docs/quick_tutorial/forms/setup.py b/docs/quick_tutorial/forms/setup.py
index 5293ef7f0..968889e74 100644
--- a/docs/quick_tutorial/forms/setup.py
+++ b/docs/quick_tutorial/forms/setup.py
@@ -1,10 +1,10 @@
from setuptools import setup
requires = [
+ 'deform',
'pyramid',
- 'waitress',
'pyramid_chameleon',
- 'deform'
+ 'waitress',
]
setup(name='tutorial',
@@ -13,4 +13,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/json/setup.py b/docs/quick_tutorial/json/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/json/setup.py
+++ b/docs/quick_tutorial/json/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/logging/setup.py b/docs/quick_tutorial/logging/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/logging/setup.py
+++ b/docs/quick_tutorial/logging/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/more_view_classes/setup.py b/docs/quick_tutorial/more_view_classes/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/more_view_classes/setup.py
+++ b/docs/quick_tutorial/more_view_classes/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst
index a65cfe6d2..29f263176 100644
--- a/docs/quick_tutorial/requirements.rst
+++ b/docs/quick_tutorial/requirements.rst
@@ -79,15 +79,15 @@ will reside as we proceed through the tutorial:
.. code-block:: text
- `── ~
- `── projects
- `── quick_tutorial
- │── env
- `── step_one
- │── intro
- │ │── __init__.py
- │ `── app.py
- `── setup.py
+ ~
+ └── projects
+ └── quick_tutorial
+ ├── env
+ └── step_one
+ ├── intro
+ │ ├── __init__.py
+ │ └── app.py
+ └── setup.py
For Linux, the commands to do so are as follows:
@@ -202,17 +202,3 @@ part is pretty easy. We'll also install a WSGI server, Waitress.
Our Python virtual environment now has the Pyramid software available
as well as the ``waitress`` package.
-You can optionally install some of the extra Python packages used in this
-tutorial.
-
-.. code-block:: bash
-
- # Mac and Linux
- $ $VENV/bin/pip install webtest pytest pytest-cov deform sqlalchemy \
- pyramid_chameleon pyramid_debugtoolbar pyramid_jinja2 waitress \
- pyramid_tm zope.sqlalchemy
-
-.. code-block:: doscon
-
- # Windows
- c:\> %VENV%\Scripts\pip install webtest pytest pytest-cov deform sqlalchemy pyramid_chameleon pyramid_debugtoolbar pyramid_jinja2 waitress pyramid_tm zope.sqlalchemy
diff --git a/docs/quick_tutorial/retail_forms/setup.py b/docs/quick_tutorial/retail_forms/setup.py
index 5293ef7f0..968889e74 100644
--- a/docs/quick_tutorial/retail_forms/setup.py
+++ b/docs/quick_tutorial/retail_forms/setup.py
@@ -1,10 +1,10 @@
from setuptools import setup
requires = [
+ 'deform',
'pyramid',
- 'waitress',
'pyramid_chameleon',
- 'deform'
+ 'waitress',
]
setup(name='tutorial',
@@ -13,4 +13,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/routing/setup.py b/docs/quick_tutorial/routing/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/routing/setup.py
+++ b/docs/quick_tutorial/routing/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/sessions/setup.py b/docs/quick_tutorial/sessions/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/sessions/setup.py
+++ b/docs/quick_tutorial/sessions/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/static_assets/setup.py b/docs/quick_tutorial/static_assets/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/static_assets/setup.py
+++ b/docs/quick_tutorial/static_assets/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
diff --git a/docs/quick_tutorial/templating/setup.py b/docs/quick_tutorial/templating/setup.py
index d1910178e..744612371 100644
--- a/docs/quick_tutorial/templating/setup.py
+++ b/docs/quick_tutorial/templating/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
- 'waitress',
'pyramid_chameleon',
+ 'waitress',
]
setup(name='tutorial',
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst
index 8da9f71b3..83b229746 100644
--- a/docs/quick_tutorial/tutorial_approach.rst
+++ b/docs/quick_tutorial/tutorial_approach.rst
@@ -15,7 +15,7 @@ This "Getting Started" tutorial is broken into independent steps, starting with
the smallest possible "single file WSGI app" example. Each of these steps
introduces a topic and a very small set of concepts via working code. The steps
each correspond to a directory in our workspace, where each step's directory is
-a Python package.
+a Python package. Source code used in this tutorial is located in the `Pyramid repository in the directory "docs/quick_tutorial" <https://github.com/Pylons/pyramid/>`_. You may ``git clone`` the repository, download, or copy-paste the source code. If you do so, then make sure you use the same branch as this documentation.
As we develop our tutorial, our directory tree will resemble the structure
below:
@@ -23,14 +23,14 @@ below:
.. code-block:: text
quick_tutorial
- │── env
- `── request_response
- `── tutorial
- │ │── __init__.py
- │ │── tests.py
- │ `── views.py
- │── development.ini
- `── setup.py
+ ├── env
+ └── request_response
+ ├── tutorial
+ │ ├── __init__.py
+ │ ├── tests.py
+ │ └── views.py
+ ├── development.ini
+ └── setup.py
Each of the directories in our ``quick_tutorial`` workspace (e.g., ``request_response``) is a *Python
project* (except as noted for the ``hello_world`` step). The ``tutorial``
diff --git a/docs/quick_tutorial/view_classes/setup.py b/docs/quick_tutorial/view_classes/setup.py
index aefa352d4..744612371 100644
--- a/docs/quick_tutorial/view_classes/setup.py
+++ b/docs/quick_tutorial/view_classes/setup.py
@@ -2,8 +2,8 @@ from setuptools import setup
requires = [
'pyramid',
+ 'pyramid_chameleon',
'waitress',
- 'pyramid_chameleon'
]
setup(name='tutorial',
@@ -12,4 +12,4 @@ setup(name='tutorial',
[paste.app_factory]
main = tutorial:main
""",
-) \ No newline at end of file
+)
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-12 03:12:14 +0000