Chris McDonough
2011-01-22 47442fb154eae5c6cd71a54e9b4aeee484e1c38b
- Add a ``MANIFEST.in`` file to each paster template. See
https://github.com/Pylons/pyramid/issues#issue/95

Closes issue #95.
13 files added
5 files modified
93 ■■■■■ changed files
CHANGES.txt 3 ●●●●● patch | view | raw | blame | history
TODO.txt 3 ●●●●● patch | view | raw | blame | history
docs/narr/MyProject/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/narr/project.rst 47 ●●●● patch | view | raw | blame | history
docs/tutorials/wiki/distributing.rst 7 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki/src/authorization/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki/src/basiclayout/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki/src/models/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki/src/views/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki2/distributing.rst 7 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki2/src/authorization/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki2/src/basiclayout/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki2/src/models/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
docs/tutorials/wiki2/src/views/MANIFEST.in 2 ●●●●● patch | view | raw | blame | history
pyramid/paster_templates/alchemy/MANIFEST.in_tmpl 2 ●●●●● patch | view | raw | blame | history
pyramid/paster_templates/routesalchemy/MANIFEST.in_tmpl 2 ●●●●● patch | view | raw | blame | history
pyramid/paster_templates/starter/MANIFEST.in_tmpl 2 ●●●●● patch | view | raw | blame | history
pyramid/paster_templates/zodb/MANIFEST.in_tmpl 2 ●●●●● patch | view | raw | blame | history
CHANGES.txt
@@ -13,6 +13,9 @@
  to ``True``.  If it is set to ``False``, the feature of the policy which
  sets a cookie with a wilcard domain will be turned off.
- Add a ``MANIFEST.in`` file to each paster template. See
  https://github.com/Pylons/pyramid/issues#issue/95
Bug Fixes
---------
TODO.txt
@@ -4,9 +4,6 @@
Must-Have (before 1.0)
----------------------
- Add MANIFEST.in to each paster template? See
  https://github.com/Pylons/pyramid/issues#issue/95
- Explain ``{foo:<regex>}`` pattern formatting and purpose better in
  within URL dispatch chapter.
docs/narr/MyProject/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include myproject *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/narr/project.rst
@@ -470,6 +470,7 @@
  MyProject/
  |-- CHANGES.txt
  |-- development.ini
  |-- MANIFEST.in
  |-- myproject
  |   |-- __init__.py
  |   |-- resources.py
@@ -508,6 +509,10 @@
#. ``setup.cfg`` is a :term:`setuptools` configuration file used by
   ``setup.py``.
#. ``MANIFEST.in`` is a :term:`distutils` "manifest" file, naming which files
    should be included in a source distribution of the package when ``python
    setup.py sdist`` is run.
#. ``setup.py`` is the file you'll use to test and distribute your
   application.  It is a standard :term:`setuptools` ``setup.py`` file.
@@ -711,18 +716,36 @@
.. warning::
   By default, ``setup.py sdist`` does not place non-Python-source files in
   generated tarballs.  This means, in this case, that the
   ``templates/mytemplate.pt`` file and the files in the ``static`` directory
   are not packaged in the tarball.  To allow this to happen, check all the
   files that you'd like to be distributed along with your application's
   Python files into Subversion.  After you do this, when you rerun
   ``setup.py sdist``, all files checked into the version control system will
   be included in the tarball.  If you don't use Subversion, and instead use
   a different version control system, you may need to install a setuptools
   add-on such as ``setuptools-git`` or ``setuptools-hg`` for this behavior
   to work properly.  Alternatively, you can specify the non-Python-source
   files by hand in a  ``manifest template``, called ``MANIFEST.in`` by default.
   Without the presence of a ``MANIFEST.in`` file or without checking your
   source code into a version control repository, ``setup.py sdist`` places
   only *Python source files* (files ending with a ``.py`` extension) into
   tarballs generated by ``python setup.py sdist``.  This means, for example,
   if your project was not checked into a setuptools-compatible source
   control system, and your project directory didn't contain a ``MANIFEST.in``
   file that told the ``sdist`` machinery to include ``*.pt`` files, the
   ``myproject/templates/mytemplate.pt`` file would not be included in the
   generated tarball.
   Projects generated by Pyramid paster templates include a default
   ``MANIFEST.in`` file.  The ``MANIFEST.in`` file contains declarations
   which tell it to include files like ``*.pt``, ``*.css`` and ``*.js`` in
   the generated tarball.  If you include files with extensions other than
   the files named in the project's ``MANIFEST.in`` and you don't make use of
   a setuptools-compatible version control system, you'll need to edit the
   ``MANIFEST.in`` file and include the statements necessary to include your
   new files.  See http://docs.python.org/distutils/sourcedist.html#principle
   for more information about how to do this.
   You can also delete ``MANIFEST.in`` from your project and rely on a
   setuptools feature which simply causes all files checked into a version
   control system to be put into the generated tarball.  To allow this to
   happen, check all the files that you'd like to be distributed along with
   your application's Python files into Subversion.  After you do this, when
   you rerun ``setup.py sdist``, all files checked into the version control
   system will be included in the tarball.  If you don't use Subversion, and
   instead use a different version control system, you may need to install a
   setuptools add-on such as ``setuptools-git`` or ``setuptools-hg`` for this
   behavior to work properly.
``setup.cfg``
~~~~~~~~~~~~~
docs/tutorials/wiki/distributing.rst
@@ -20,13 +20,6 @@
   c:\pyramidtut> ..\Scripts\python setup.py sdist
.. warning:: If your project files are not checked in to a version
   control repository (such as Subversion), the dist tarball will
   *not* contain all the files it needs to.  In particular, it will
   not contain non-Python-source files (such as templates and static
   files).  To ensure that these are included, check your files into a
   version control repository before running ``setup.py sdist``.
The output of such a command will be something like:
.. code-block:: text
docs/tutorials/wiki/src/authorization/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki/src/basiclayout/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki/src/models/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki/src/views/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki2/distributing.rst
@@ -20,13 +20,6 @@
   c:\pyramidtut> ..\Scripts\python setup.py sdist
.. warning:: If your project files are not checked in to a version
   control repository (such as Subversion), the dist tarball will
   *not* contain all the files it needs to.  In particular, it will
   not contain non-Python-source files (such as templates and static
   files).  To ensure that these are included, check your files into a
   version control repository before running ``setup.py sdist``.
The output of such a command will be something like:
.. code-block:: text
docs/tutorials/wiki2/src/authorization/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki2/src/basiclayout/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki2/src/models/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
docs/tutorials/wiki2/src/views/MANIFEST.in
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
pyramid/paster_templates/alchemy/MANIFEST.in_tmpl
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include {{package}} *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
pyramid/paster_templates/routesalchemy/MANIFEST.in_tmpl
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include {{package}} *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
pyramid/paster_templates/starter/MANIFEST.in_tmpl
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include {{package}} *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js
pyramid/paster_templates/zodb/MANIFEST.in_tmpl
New file
@@ -0,0 +1,2 @@
include *.txt *.ini *.cfg *.rst
recursive-include {{package}} *.ico *.png *.css *.gif *.jpg *.pt *.mak *.js