Commits

Anonymous committed a3338af

added quickstart guide w/pumazi

  • Participants
  • Parent commits c086827

Comments (0)

Files changed (3)

File source/creation.txt

 them. Let's go with "TowelStuff" since it seems appropriate and also
 it has not yet been used on the :ref:`pypi_info`.
 
-.. _rest_example:
+.. _directory_layout:
 
 Arranging your file and directory structure
 -------------------------------------------
 
 Here's what you should do for each of those listed above:
 
+.. _bin_description:
+
 * Put into ``bin`` any scripts you've written that use your
   ``towelstuff`` package and which you think would be useful for your
   users. If you don't have any, then remove the ``bin`` directory.
 
+.. _changes_txt_description:
+
 * For now, the ``CHANGES.txt`` file should only contain::
 
       v<version>, <date> -- Initial release.
   since this is your very first version (version number will be
   described below) and there are no changes to report.
 
+.. _docs_description:
+
 * The ``docs`` dir should contain any design docs, implementation notes, a
   FAQ, or any other docs you've written. For now, stick to plain text
   files ending in ".txt". This author (JohnMG) likes to use `Pandoc's
   Markdown <http://johnmacfarlane.net/pandoc/>`_, but many Pythoneers
   use :term:`reStructuredText <reStructuredText>`.
 
+.. _license_txt_description:
+
 * The ``LICENSE.txt`` file is often just a copy/paste of your license
   of choice.  We recommend going with a commonly-used license, such as
   the GPL, BSD, or MIT.
 
+.. _manifest_in_description:
+
 * The ``MANIFEST.in`` file should contain this::
 
       include *.txt
       recursive-include docs *.txt
 
+.. _readme_txt_description:
+
 * The ``README.txt`` file should be written in :term:`reST <reStructuredText>`
   so that the PyPI can use it to generate your project's PyPI page. Here's a
   10-second intro to reST that you might use to start with::
   html, see the `TowelStuff project
   <http://pypi.python.org/pypi/TowelStuff/>`_ at the PyPI.
 
+.. _setup_py_description:
+
 * ``setup.py`` -- Create this file and make it look like this::
 
       from distutils.core import setup
   If you have no scripts to distribute (and thus no ``bin`` dir), you
   can remove the above line which begins with "scripts".
 
+.. _towelstuff_description:
+
 * Inside the ``towelstuff`` directory, ``__init__.py`` can be
   empty. Likewise, inside ``towelstuff/test``, *that* ``__init__.py``
   can be empty as well. If you have no tests written yet, you can

File source/index.txt

 .. toctree::
    :maxdepth: 2
 
+   quickstart.txt
+
    introduction.txt
    installation.txt
 
    credits.txt
    license.txt
 
-.. index:: quick start;
-
-Quick Start
-===========
-
-
-
-Grab Your Towel and Save the Universe
-=====================================
-
-The `Quick Start`_ is a good brief introduction, but does not cover a lot of obscure use-cases. For those wanting more, please read the :doc:`introduction` document to gain a better understanding of the :ref:`state_of_packaging_info`.
-
 Indices and tables
 ==================
 

File source/quickstart.txt

+===========
+Quick Start
+===========
+
+Here's how to create a new project; we'll call our example TowelStuff.
+
+1. Lay out your project main directory.
+=======================================
+
+Under the main directory, you'll **need** a :ref:`setup.py
+<setup_py_description>` and at least one package directory,
+:ref:`towelstuff/ <towelstuff_description>` (which is what's actually
+imported when you do ``import towelstuff``).  You will also need a
+:ref:`MANIFEST.in <manifest_in_description>` to bundle non-source
+files in the distribution -- unless you're using Subversion.  (Don't
+ask.)  If you have any command line scripts, put them in the
+:ref:`bin/ <bin_description>` directory.
+
+We **highly recommend** a :ref:`README.txt <readme_txt_description>`
+file describing your project and where to go for more information, and
+a :ref:`LICENSE.txt <license_txt_description>` file containing the
+license of your project.
+
+If you want full marks on your project, please also include a
+:ref:`CHANGES.txt <changes_txt_description>`
+and a :ref:`docs/ <docs_description>` directory containing any documentation.
+
+.. note:: For full details, look at :ref:`directory_layout`.
+
+2. Register your package with the Python Package Index (PyPI)
+=============================================================
+
+To register your package on the :ref:`pypi_info`, run ::
+
+ $ python setup.py register
+
+.. note:: You may need to do this every time you change ``README.txt``.
+
+3. For each release, build and upload the package.
+==================================================
+
+Whenever you release a new version, build your package and then upload
+it to PyPI.  The following command line will create a source distribution
+and Windows binary installer, and then upload both of them to PyPI. ::
+
+ $ python setup.py sdist bdist_msi upload
+
+4. Go find some users.
+======================
+
+At this point you should announce your package to the community!
+
+Grab Your Towel and Save the Universe
+=====================================
+
+The `Quick Start`_ is a good brief introduction, but does not cover a lot of obscure use-cases. For those wanting more, please read the :doc:`introduction` document to gain a better understanding of the :ref:`state_of_packaging_info`.
+