| Éric Araujo | 55729fe | 2011-06-02 15:45:25 +0200 | [diff] [blame^] | 1 | .. _packaging-install-index: |
| 2 | |
| 3 | ****************************** |
| 4 | Installing Python Projects |
| 5 | ****************************** |
| 6 | |
| 7 | :Author: Greg Ward and Packaging contributors |
| 8 | :Release: |version| |
| 9 | :Date: |today| |
| 10 | |
| 11 | .. TODO: Fill in XXX comments |
| 12 | |
| 13 | .. The audience for this document includes people who don't know anything |
| 14 | about Python and aren't about to learn the language just in order to |
| 15 | install and maintain it for their users, i.e. system administrators. |
| 16 | Thus, I have to be sure to explain the basics at some point: |
| 17 | sys.path and PYTHONPATH at least. Should probably give pointers to |
| 18 | other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc. |
| 19 | |
| 20 | Finally, it might be useful to include all the material from my "Care |
| 21 | and Feeding of a Python Installation" talk in here somewhere. Yow! |
| 22 | |
| 23 | .. topic:: Abstract |
| 24 | |
| 25 | This document describes Packaging from the end-user's point of view: it |
| 26 | explains how to extend the functionality of a standard Python installation by |
| 27 | building and installing third-party Python modules and applications. |
| 28 | |
| 29 | |
| 30 | This guide is split into a simple overview followed by a longer presentation of |
| 31 | the :program:`pysetup` script, the Python package management tool used to |
| 32 | build, distribute, search for, install, remove and list Python distributions. |
| 33 | |
| 34 | .. TODO integrate install and pysetup instead of duplicating |
| 35 | |
| 36 | .. toctree:: |
| 37 | :maxdepth: 2 |
| 38 | :numbered: |
| 39 | |
| 40 | install |
| 41 | pysetup |
| 42 | pysetup-config |
| 43 | pysetup-servers |
| 44 | |
| 45 | |
| 46 | .. seealso:: |
| 47 | |
| 48 | :ref:`packaging-index` |
| 49 | The manual for developers of Python projects who want to package and |
| 50 | distribute them. This describes how to use :mod:`packaging` to make |
| 51 | projects easily found and added to an existing Python installation. |
| 52 | |
| 53 | :mod:`packaging` |
| 54 | A library reference for developers of packaging tools wanting to use |
| 55 | standalone building blocks like :mod:`~packaging.version` or |
| 56 | :mod:`~packaging.metadata`, or extend Packaging itself. |