Text of docs.python.org › 3.11 › install › index.html as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Installing Python Modules (Legacy version) — Python 3.11.18 documentation

Navigation index modules | previous | Python » 3.11.18 Documentation » Installing Python Modules (Legacy version) | Theme | Installing Python Modules (Legacy version) ¶ Author : Greg Ward Note The entire distutils package has been deprecated and will be removed in Python 3.12. This documentation is retained as a reference only, and will be removed with the package. See the What’s New entry for more information. See also Installing Python Modules The up to date module installation documentation.

For regular Python usage, you almost certainly want that document rather than this one. Note This document is being retained solely until the setuptools documentation at https://setuptools.readthedocs.io/en/latest/setuptools.html independently covers all of the relevant information currently included here. Note This guide only covers the basic tools for building and distributing extensions that are provided as part of this version of Python.

Third party tools offer easier to use and more secure alternatives. Refer to the quick recommendations section in the Python Packaging User Guide for more information. Introduction ¶ In Python 2.0, the distutils API was first added to the standard library. This provided Linux distro maintainers with a standard way of converting Python projects into Linux distro packages, and system administrators with a standard way of installing them directly onto target systems.

In the many years since Python 2.0 was released, tightly coupling the build system and package installer to the language runtime release cycle has turned out to be problematic, and it is now recommended that projects use the pip package installer and the setuptools build system, rather than using distutils directly. See Installing Python Modules and Distributing Python Modules for more details. This legacy documentation is being retained only until we’re confident that the setuptools documentation covers everything needed.

Distutils based source distributions ¶ If you download a module source distribution, you can tell pretty quickly if it was packaged and distributed in the standard way, i.e. using the Distutils. First, the distribution’s name and version number will be featured prominently in the name of the downloaded archive, e.g. foo-1.0.tar.gz or widget-0.9.7.zip . Next, the archive will unpack into a similarly named directory: foo-1.0 or widget-0.9.7 .

Additionally, the distribution will contain a setup script setup.py , and a file named README.txt or possibly just README , which should explain that 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 window ( Start ‣ Accessories ): 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 really need this manual. Or rather, the above command is everything you need to get out of this manual. Standard Build and Install ¶ As described in section Distutils based source distributions , building and installing a module distribution using the Distutils is usually one simple command to run from a terminal: python setup.py install Platform variations ¶ You should always run the setup command from the distribution root directory, i.e. the top-level subdirectory that the module source distribution unpacks into.

For example, if you’ve just downloaded a module source distribution foo-1.0.tar.gz onto a Unix system, the normal thing to do is: gunzip -c foo-1.0.tar.gz | tar xf - # unpacks into directory foo-1.0 cd foo-1.0 python setup.py install On Windows, you’d probably download foo-1.0.zip . If you downloaded the archive file to C:\Temp , then it would unpack into C:\Temp\foo-1.0 ; you can use either an archive manipulator with a graphical user interface (such as WinZip) or a command-line tool (such as unzip or pkunzip ) to unpack the archive.

Then, open a command prompt window and run: cd c:\Temp\foo-1.0 python setup.py install Splitting the job up ¶ Running setup.py install builds and installs all modules in one run. If you prefer to work incrementally—especially useful if you want to customize the build process, or if things are going wrong—you can use the setup script to do one thing at a time. This is particularly helpful when the build and install will be done by different users—for example, you might want to build a module distribution and hand it off to a system administrator for installation (or do it yourself, with super-user privileges).

For example, you can build everything in one step, and then install everything in a second step, by invoking the setup script twice: python setup.py build python setup.py install If you do this, you will notice that running the install command first runs the build command, which—in this case—quickly notices that it has nothing to do, since everything in the build directory is up-to-date. You may not need this ability to break things down often if all you do is install modules downloaded off the ‘net, but it’s very handy for more advanced tasks.

If you get into distributing your own Python modules and extensions, you’ll run lots of individual Distutils commands on their own. How building works ¶ As implied above, the build command is responsible for putting the files to install into a build directory . By default, this is build under the distribution root; if you’re excessively concerned with speed, or want to keep the source tree pristine, you can change the build directory with the --build-base option.

For example: python setup.py build --build-base=/path/to/pybuild/foo-1.0 (Or you could do this permanently with a directive in your system or personal Distutils configuration file; see section Distutils Configuration Files .) Normally, this isn’t necessary. The default layout for the build tree is as follows: --- build/ --- lib/ or --- build/ --- lib.<plat>/ temp.<plat>/ where <plat> expands to a brief description of the current OS/hardware platform and Python version.

The first form, with just a lib directory, is used for “pure module distributions”—that is, module distributions that include only pure Python modules. If a module distribution contains any extensions (modules written in C/C++), then the second form, with two <plat> directories, is used. In that case, the temp. plat directory holds temporary files generated by the compile/link process that don’t actually get installed.

In either case, the lib (or lib. plat ) directory contains all Python modules (pure Python and extensions) that will be installed. In the future, more directories will be added to handle Python scripts, documentation, binary executables, and whatever else is needed to handle the job of installing Python modules and applications. How installation works ¶ After the build command runs (whether you run it explicitly, or the install command does it for you), the work of the install command is relatively simple: all it has to do is copy everything under build/lib (or build/lib. plat ) to your chosen installation directory.

If you don’t choose an installation directory—i.e., if you just run setup.py install —then the install command installs to the standard location for third-party Python modules. This location varies by platform and by how you built/installed Python itself. On Unix (and macOS, which is also Unix-based), it also depends on whether the module distribution being installed is pure Python or contains extensions (“non-pure”): Platform Standard installation location Default value Notes Unix (pure) prefix /lib/python X.Y /site-packages /usr/local/lib/python X.Y /site-packages (1) Unix (non-pure) exec-prefix /lib/python X.Y /site-packages /usr/local/lib/python X.Y /site-packages (1) Windows prefix \Lib

The rest of this page is on the live site.