Merge branch 'master' into feature/alchemy-scaffold-update

.travis.yml

@@ -2,18 +2,28 @@
 language: python
 sudo: false
 
-env:
-  - TOXENV=py26
-  - TOXENV=py27
-  - TOXENV=py32
-  - TOXENV=py33
-  - TOXENV=py34
-  - TOXENV=pypy
-  - TOXENV=pypy3
-  - TOXENV=py2-docs
-  - TOXENV=py3-docs
-  - TOXENV=py2-cover,py3-cover,coverage
-  - TOXENV=pep8
+matrix:
+    include:
+        - python: 2.6
+          env: TOXENV=py26
+        - python: 2.7
+          env: TOXENV=py27
+        - python: 3.2
+          env: TOXENV=py32
+        - python: 3.3
+          env: TOXENV=py33
+        - python: 3.4
+          env: TOXENV=py34
+        - python: 3.5
+          env: TOXENV=py35
+        - python: pypy
+          env: TOXENV=pypy
+        - python: pypy3
+          env: TOXENV=pypy3
+        - python: 3.5
+          env: TOXENV=py2-cover,py3-cover,coverage
+        - python: 3.5
+          env: TOXENV=pep8
 
 install:
   - travis_retry pip install tox

CHANGES.txt

@@ -4,6 +4,12 @@
 Features
 --------
 
+- pcreate will now ask for confirmation if invoked with
+  an argument for a project name that already exists or
+  is importable in the current environment.
+  See https://github.com/Pylons/pyramid/issues/1357 and
+  https://github.com/Pylons/pyramid/pull/1837
+
 - Make it possible to subclass ``pyramid.request.Request`` and also use
   ``pyramid.request.Request.add_request.method``.  See
   https://github.com/Pylons/pyramid/issues/1529
@@ -128,6 +134,13 @@ Features
   that as the response class instead of the default ``HTTPFound``.  See
   https://github.com/Pylons/pyramid/pull/1610
 
+- Additional shells for ``pshell`` can now be registered as entrypoints. See
+  https://github.com/Pylons/pyramid/pull/1891
+
+- The variables injected into ``pshell`` are now displayed with their
+  docstrings instead of the default ``str(obj)`` when possible.
+  See https://github.com/Pylons/pyramid/pull/1929
+
 Bug Fixes
 ---------
 
@@ -195,9 +208,25 @@ Bug Fixes
   default to an iterable instead of ``None``. It may be checked for a length
   of 0. This was the behavior in 1.5.
 
+- ``pyramid.httpexceptions.HTTPException`` now defaults to
+  ``520 Unknown Error`` instead of ``None None`` to conform with changes in
+  WebOb 1.5.
+  See https://github.com/Pylons/pyramid/pull/1865
+
 Deprecations
 ------------
 
+- The ``pserve`` command's daemonization features have been deprecated. This
+  includes the ``[start,stop,restart,status]`` subcommands as well as the
+  ``--daemon``, ``--stop-server``, ``--pid-file``, and ``--status`` flags.
+
+  Please use a real process manager in the future instead of relying on the
+  ``pserve`` to daemonize itself. Many options exist including your Operating
+  System's services such as Systemd or Upstart, as well as Python-based
+  solutions like Circus and Supervisor.
+
+  See https://github.com/Pylons/pyramid/pull/1641
+
 - Renamed the ``principal`` argument to ``pyramid.security.remember()`` to
   ``userid`` in order to clarify its intended purpose.
   See https://github.com/Pylons/pyramid/pull/1399

CONTRIBUTORS.txt

@@ -248,3 +248,9 @@ Contributors
 - Donald Stufft, 2015/03/15
 
 - Randy Topliffe, 2015/04/14
+
+- Karen Dalton, 2015/06/01
+
+- Igor Stroh, 2015/06/10
+
+- Jesse Dhillon, 2015/10/07

HACKING.txt

@@ -189,7 +189,7 @@ Running Tests
   Run the tests like so::
 
    $ $VENV/bin/easy_install pytest
-   $ py.test --strict pyramid/
+   $ $VENV/bin/py.test --strict pyramid/
 
 - Functional tests related to the "scaffolds" (starter, zodb, alchemy) which
   create a virtualenv, install the scaffold package and its dependencies, start

README.rst

@@ -12,6 +12,10 @@ Pyramid
         :target: http://docs.pylonsproject.org/projects/pyramid/en/latest/
         :alt: Latest Documentation Status
 
+.. image:: https://img.shields.io/badge/irc-freenode-blue.svg
+        :target: https://webchat.freenode.net/?channels=pyramid
+        :alt: IRC Freenode
+
 Pyramid is a small, fast, down-to-earth, open source Python web framework.
 It makes real-world web application development and
 deployment more fun, more predictable, and more productive.

contributing.md

@@ -0,0 +1,87 @@
+Contributing
+============
+
+All projects under the Pylons Projects, including this one, follow the
+guidelines established at [How to
+Contribute](http://www.pylonsproject.org/community/how-to-contribute).
+
+You can contribute to this project in several ways.
+
+* [File an Issue on GitHub](https://github.com/Pylons/pyramid/issues)
+* Fork this project and create a branch with your suggested change. When ready,
+  submit a pull request for consideration. [GitHub
+  Flow](https://guides.github.com/introduction/flow/index.html) describes the
+  workflow process and why it's a good practice. When submitting a pull
+  request, sign
+  [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS.
+txt)
+  if you have not yet done so.
+* Join the IRC channel #pyramid on irc.freenode.net.
+
+Prerequisites
+-------------
+
+Follow the instructions in HACKING.txt for your version or branch located in
+the [root of the Pyramid repository](https://github.com/Pylons/pyramid/) to
+install Pyramid and the tools needed to run its tests and build its
+documentation.
+
+Building documentation for a Pylons Project project
+---------------------------------------------------
+
+*Note:* These instructions might not work for Windows users. Suggestions to
+improve the process for Windows users are welcome by submitting an issue or a
+pull request. Windows users may find it helpful to follow the guide [Installing
+Pyramid on a Windows
+System](http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/install.html#installing-pyramid-on-a-windows-system).
+
+1.  Fork the repo on GitHub by clicking the [Fork] button.
+2.  Clone your fork into a workspace on your local machine.
+
+         [email protected]:<username>/pyramid.git
+
+3.  Add a git remote "upstream" for the cloned fork.
+
+         git remote add upstream [email protected]:Pylons/pyramid.git
+
+4.  Set an environment variable as instructed in the
+    [prerequisites](https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L55-L58).
+
+         # Mac and Linux
+         $ export VENV=~/hack-on-pyramid/env
+
+         # Windows
+         set VENV=c:\hack-on-pyramid\env
+
+5.  Try to build the docs in your workspace.
+
+         # Mac and Linux
+         $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build
+
+         # Windows
+         c:\> make clean html SPHINXBUILD=%VENV%\bin\sphinx-build
+
+     If successful, then you can make changes to the documentation. You can
+     load the built documentation in the `/_build/html/` directory in a web
+     browser.
+
+6.  From this point forward, follow the typical git workflow.  Start by pulling
+    from the upstream to get the most current changes.
+
+         git pull upstream master
+
+7.  Make a branch, make changes to the docs, and rebuild them as indicated in
+    step 5.  To speed up the build process, you can omit `clean` from the above
+    command to rebuild only those pages that depend on the files you have
+    changed.
+
+8.  Once you are satisfied with your changes and the documentation builds
+    successfully without errors or warnings, then git commit and push them to
+    your "origin" repository on GitHub.
+
+         git commit -m "commit message"
+         git push -u origin --all # first time only, subsequent can be just 'git push'.
+
+9.  Create a [pull request](https://help.github.com/articles/using-pull-requests/).
+
+10.  Repeat the process starting from Step 6.

docs/api/request.rst

@@ -11,7 +11,7 @@
    :exclude-members: add_response_callback, add_finished_callback,
                      route_url, route_path, current_route_url,
                      current_route_path, static_url, static_path,
-                     model_url, resource_url, set_property, 
+                     model_url, resource_url, resource_path, set_property, 
                      effective_principals, authenticated_userid,
                      unauthenticated_userid, has_permission
 

docs/conf.py

@@ -58,37 +58,24 @@ def nothing(*arg):
 
 # Looks for objects in external projects
 intersphinx_mapping = {
-    'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None),
+    'colander': (        'http://docs.pylonsproject.org/projects/colander/en/latest', None),
     'cookbook': ('http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None),
+    'deform': ('http://docs.pylonsproject.org/projects/deform/en/latest', None),
     'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None),
-    'tm': (
-        'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/',
-        None,
-    ),
-    'zcomponent': ('http://docs.zope.org/zope.component', None),
-    'webtest': ('http://webtest.pythonpaste.org/en/latest', None),
-    'webob': ('http://docs.webob.org/en/latest', None),
-    'colander': (
-        'http://docs.pylonsproject.org/projects/colander/en/latest',
-    None),
-    'deform': (
-        'http://docs.pylonsproject.org/projects/deform/en/latest',
-    None),
-    'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
-    'who': ('http://repozewho.readthedocs.org/en/latest', None),
+    'pylonswebframework': ('http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None),
     'python': ('http://docs.python.org', None),
     'python3': ('http://docs.python.org/3', None),
-    'tstring':
-        ('http://docs.pylonsproject.org/projects/translationstring/en/latest',
-          None),
-    'venusian':
-        ('http://docs.pylonsproject.org/projects/venusian/en/latest', None),
-    'toolbar':
-        ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest',
-         None),
-    'zcml':
-        ('http://docs.pylonsproject.org/projects/pyramid-zcml/en/latest',
-         None),
+    'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
+    'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/',         None),
+    'toolbar':         ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None),
+    'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None),
+    'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None),
+    'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None),
+    'webob': ('http://docs.webob.org/en/latest', None),
+    'webtest': ('http://webtest.pythonpaste.org/en/latest', None),
+    'who': ('http://repozewho.readthedocs.org/en/latest', None),
+    'zcml': ('http://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', None),
+    'zcomponent': ('http://docs.zope.org/zope.component', None),
 }
 
 

docs/conventions.rst

@@ -1,19 +1,19 @@
 Typographical Conventions
 =========================
 
-Literals, filenames and function arguments are presented using the
+Literals, filenames, and function arguments are presented using the
 following style:
 
   ``argument1``
 
-Warnings, which represent limitations and need-to-know information
+Warnings which represent limitations and need-to-know information
 related to a topic or concept are presented in the following style:
 
   .. warning::
 
      This is a warning.
 
-Notes, which represent additional information related to a topic or
+Notes which represent additional information related to a topic or
 concept are presented in the following style:
 
   .. note::
@@ -24,7 +24,7 @@ We present Python method names using the following style:
 
   :meth:`pyramid.config.Configurator.add_view`
 
-We present Python class names, module names, attributes and global
+We present Python class names, module names, attributes, and global
 variables using the following style:
 
   :class:`pyramid.config.Configurator.registry`
@@ -105,10 +105,10 @@ It may look unusual, but it has advantages:
 
 * It allows one to swap out the higher-level package ``foo`` for something
   else that provides the similar API. An example would be swapping out
-  one Database for another (e.g. graduating from SQLite to PostgreSQL).
+  one database for another (e.g., graduating from SQLite to PostgreSQL).
 
 * Looks more neat in cases where a large number of objects get imported from
   that package.
 
-* Adding/removing imported objects from the package is quicker and results
+* Adding or removing imported objects from the package is quicker and results
   in simpler diffs.

docs/copyright.rst

@@ -39,7 +39,7 @@ any trademark or service mark.
 
 Every effort has been made to make this book as complete and as
 accurate as possible, but no warranty or fitness is implied.  The
-information provided is on as "as-is" basis.  The author and the
+information provided is on an "as-is" basis.  The author and the
 publisher shall have neither liability nor responsibility to any
 person or entity with respect to any loss or damages arising from the
 information contained in this book.  No patent liability is assumed
@@ -89,14 +89,14 @@ Contacting The Publisher
 Please send documentation licensing inquiries, translation inquiries,
 and other business communications to `Agendaless Consulting
 <mailto:[email protected]>`_.  Please send software and other
-technical queries to the `Pylons-devel maillist
+technical queries to the `Pylons-devel mailing list
 <http://groups.google.com/group/pylons-devel>`_.
 
 HTML Version and Source Code
 ----------------------------
 
 An HTML version of this book is freely available via
-http://docs.pylonsproject.org
+http://docs.pylonsproject.org/projects/pyramid/en/latest/
 
 The source code for the examples used in this book are available
 within the :app:`Pyramid` software distribution, always available