(original) (raw)

changeset: 70716:2951641faed1 branch: 2.7 parent: 70661:6e7a98cfcfab user: Éric Araujo merwok@netwok.org date: Wed Jun 08 01:11:36 2011 +0200 files: Doc/distutils/introduction.rst Doc/install/index.rst description: Add examples that work on Windows to distutils docs (#1626300) diff -r 6e7a98cfcfab -r 2951641faed1 Doc/distutils/introduction.rst --- a/Doc/distutils/introduction.rst Mon Jun 06 17:11:31 2011 +0200 +++ b/Doc/distutils/introduction.rst Wed Jun 08 01:11:36 2011 +0200 @@ -79,11 +79,17 @@ for an example) To create a source distribution for this module, you would create a setup -script, :file:`setup.py`, containing the above code, and run:: +script, :file:`setup.py`, containing the above code, and run this command from a +terminal:: python setup.py sdist -which will create an archive file (e.g., tarball on Unix, ZIP file on Windows) +For Windows, open a command prompt windows ("DOS box") and change the command +to:: + + setup.py sdist + +:command:`sdist` will create an archive file (e.g., tarball on Unix, ZIP file on Windows) containing your setup script :file:`setup.py`, and your module :file:`foo.py`. The archive file will be named :file:`foo-1.0.tar.gz` (or :file:`.zip`), and will unpack into a directory :file:`foo-1.0`. diff -r 6e7a98cfcfab -r 2951641faed1 Doc/install/index.rst --- a/Doc/install/index.rst Mon Jun 06 17:11:31 2011 +0200 +++ b/Doc/install/index.rst Wed Jun 08 01:11:36 2011 +0200 @@ -96,10 +96,16 @@ directory: :file:`foo-1.0` or :file:`widget-0.9.7`. Additionally, the distribution will contain a setup script :file:`setup.py`, and a file named :file:`README.txt` or possibly just :file:`README`, which should explain that -building and installing the module distribution is a simple matter of running :: +building and installing the module distribution is a simple matter of running +one command from a terminal:: python setup.py install +For Windows, this command should be run from a command prompt windows ("DOS +box"):: + + setup.py install + If all these things are true, then you already know how to build and install the modules you've just downloaded: Run the command above. Unless you need to install things in a non-standard way or customize the build process, you don't @@ -113,14 +119,11 @@ ========================== As described in section :ref:`inst-new-standard`, building and installing a module -distribution using the Distutils is usually one simple command:: +distribution using the Distutils is usually one simple command to run from a +terminal:: python setup.py install -On Unix, you'd run this command from a shell prompt; on Windows, you have to -open a command prompt window ("DOS box") and do it there; on Mac OS X, you open -a :command:`Terminal` window to get a shell prompt. - .. _inst-platform-variations: /merwok@netwok.org