summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki/distributing.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-10-25 17:40:43 -0400
committerChris McDonough <chrism@plope.com>2010-10-25 17:40:43 -0400
commite53e13423685eac190676c4be32716c3a42603e4 (patch)
treea28909e6aa70ed35977d4fa7e7af8ce6e0cb7332 /docs/tutorials/wiki/distributing.rst
parentae8e4ad63449212da28c6a169c36aac54ed38a9e (diff)
downloadpyramid-e53e13423685eac190676c4be32716c3a42603e4.tar.gz
pyramid-e53e13423685eac190676c4be32716c3a42603e4.tar.bz2
pyramid-e53e13423685eac190676c4be32716c3a42603e4.zip
rename bfgwiki to wiki
Diffstat (limited to 'docs/tutorials/wiki/distributing.rst')
-rw-r--r--docs/tutorials/wiki/distributing.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/tutorials/wiki/distributing.rst b/docs/tutorials/wiki/distributing.rst
new file mode 100644
index 000000000..81ec61a63
--- /dev/null
+++ b/docs/tutorials/wiki/distributing.rst
@@ -0,0 +1,49 @@
+=============================
+Distributing Your Application
+=============================
+
+Once your application works properly, you can create a "tarball" from
+it by using the ``setup.py sdist`` command. The following commands
+assume your current working directory is the ``tutorial`` package
+we've created and that the parent directory of the ``tutorial``
+package is a virtualenv representing a :mod:`pyramid` environment.
+
+On UNIX:
+
+.. code-block:: text
+
+ $ ../bin/python setup.py sdist
+
+On Windows:
+
+.. code-block:: text
+
+ c:\bigfntut> ..\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
+
+ running sdist
+ # .. more output ..
+ creating dist
+ tar -cf dist/tutorial-0.1.tar tutorial-0.1
+ gzip -f9 dist/tutorial-0.1.tar
+ removing 'tutorial-0.1' (and everything under it)
+
+Note that this command creates a tarball in the "dist" subdirectory
+named ``tutorial-0.1.tar.gz``. You can send this file to your friends
+to show them your cool new application. They should be able to
+install it by pointing the ``easy_install`` command directly at it.
+Or you can upload it to `PyPI <http://pypi.python.org>`_ and share it
+with the rest of the world, where it can be downloaded via
+``easy_install`` remotely like any other package people download from
+PyPI.
+