Skip to content

Commit

Permalink
cleanup, added some 'see also's
Browse files Browse the repository at this point in the history
  • Loading branch information
Scott Torborg committed Nov 18, 2012
1 parent e1be75a commit 0c48f34
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
10 changes: 8 additions & 2 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
How To Package Your Python Code
===============================

This tutorial aims to clarify the current state of Python packaging, and put forth an opinionated and specific pattern to make trouble-free packages for community use. The documentation herein doesn't describe the *only* way of doing things, merely one specific approach that works well.
This tutorial aims to put forth an opinionated and specific pattern to make trouble-free packages for community use. It doesn't describe the *only* way of doing things, merely one specific approach that works well.

In particular, those packages should make it easy:
In particular, packages should make it easy:

* To install with ``pip`` or ``easy_install``.
* To specify as a dependency for another package.
Expand All @@ -29,3 +29,9 @@ We'll walk through the basic steps of building up a contrived package **funniest
.. note::

At this time, this documentation focuses on Python 2.x only, and may not be *as* applicable to packages targeted to Python 3.x.

.. seealso::

`Setuptools Documentation <http://peak.telecommunity.com/DevCenter/setuptools>`_
Core setuptools documentation and API reference.

4 changes: 4 additions & 0 deletions minimal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ You can combine all of these steps, to update metadata and publish a new build i

$ python setup.py register sdist upload

For a detailed list of all available setup.py commands, do::

$ python setup.py --help-commands


Installing the Package
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The ``test_joke.py`` file is our first test file. Although it's overkill for now

The best way to get these tests going (particularly if you're not sure what to use) is `Nose <https://nose.readthedocs.org/en/latest/>`_. With those files added, it's just a matter of running this from the root of the repository::

$ pip install nose
$ nosetests

To integrate this with our ``setup.py``, and ensure that Nose is installed when we run the tests, we'll add a few lines to ``setup()``::
Expand Down

0 comments on commit 0c48f34

Please sign in to comment.