From 0c48f3461aca2ac219f9ecb9f1d3cb4bde181f9e Mon Sep 17 00:00:00 2001 From: Scott Torborg Date: Sat, 17 Nov 2012 16:10:50 -0800 Subject: [PATCH] cleanup, added some 'see also's --- index.rst | 10 ++++++++-- minimal.rst | 4 ++++ testing.rst | 1 + 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/index.rst b/index.rst index 138d858..117ef96 100644 --- a/index.rst +++ b/index.rst @@ -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. @@ -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 `_ + Core setuptools documentation and API reference. + diff --git a/minimal.rst b/minimal.rst index 6b85857..8747321 100644 --- a/minimal.rst +++ b/minimal.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/testing.rst b/testing.rst index ea1e06f..5b674e6 100644 --- a/testing.rst +++ b/testing.rst @@ -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 `_. 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()``::