summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki/distributing.rst
blob: 81ec61a63b9d35d84f426d4a397247b9dc215ab3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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.