diff options
| author | Chris McDonough <chrism@plope.com> | 2012-03-18 23:50:24 -0400 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-03-18 23:50:24 -0400 |
| commit | 7b55442a0947663f3f1e76a504a9cb33d8d53086 (patch) | |
| tree | cab9bbb1557ddfb55c1a2bbc2a3bf248577fd50f | |
| parent | 5cccad104522cb5b8de0e683ea3a1d5bad91d518 (diff) | |
| download | pyramid-7b55442a0947663f3f1e76a504a9cb33d8d53086.tar.gz pyramid-7b55442a0947663f3f1e76a504a9cb33d8d53086.tar.bz2 pyramid-7b55442a0947663f3f1e76a504a9cb33d8d53086.zip | |
warn about project names that shadow stdlib names, change UNIX prompt to gt
| -rw-r--r-- | docs/narr/project.rst | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst index 318d932fe..0134f4c74 100644 --- a/docs/narr/project.rst +++ b/docs/narr/project.rst @@ -83,7 +83,7 @@ Or on Windows: .. code-block:: text - $ Scripts\pcreate -s starter MyProject + > Scripts\pcreate -s starter MyProject The above command uses the ``pcreate`` command to create a project with the ``starter`` scaffold. To use a different scaffold, such as @@ -98,7 +98,7 @@ Or on Windows: .. code-block:: text - $ Scripts\pcreate -s alchemy MyProject + > Scripts\pcreate -s alchemy MyProject Here's sample output from a run of ``pcreate`` on UNIX for a project we name ``MyProject``: @@ -132,6 +132,14 @@ The ``MyProject`` project directory contains an additional subdirectory named :term:`package` which holds very simple :app:`Pyramid` sample code. This is where you'll edit your application's Python code and templates. +.. warning:: + + You’ll need to avoid using ``pcreate`` to create a project with the same + as a Python standard library component. In particular, this means you + should avoid using names the names ``site`` or ``test``, both of which + conflict with Python standard library packages. You should also avoid + using the name ``pyramid``, which will conflict with Pyramid itself. + .. index:: single: setup.py develop single: development install @@ -161,8 +169,8 @@ Or on Windows: .. code-block:: text - $ cd MyProject - $ ..\Scripts\python.exe setup.py develop + > cd MyProject + > ..\Scripts\python.exe setup.py develop Elided output from a run of this command on UNIX is shown below: @@ -200,7 +208,7 @@ Or on Windows: .. code-block:: text - $ ..\Scripts\python.exe setup.py test -q + > ..\Scripts\python.exe setup.py test -q Here's sample output from a test run on UNIX: @@ -256,7 +264,7 @@ On Windows: .. code-block:: text - $ ..\Scripts\pserve development.ini + > ..\Scripts\pserve development.ini Here's sample output from a run of ``pserve`` on UNIX: |