Python Packaging User Guide

https://packaging.python.org/en/latest/
Admin
Python Packaging User Guide is a comprehensive collection of tutorials, guides, and specifications...
Tokens:82,775
Snippets:1,333
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### INSTALLER file examples

Source: https://packaging.python.org/en/latest/specifications/recording-installed-packages

Examples of single-line text files naming the tool used to install a project.

```text
pip

```

```text
MegaCorp Cloud Install-O-Matic

```

--------------------------------

### Example installation output

Source: https://packaging.python.org/en/latest/tutorials/packaging-projects

Expected output after successfully installing the package from TestPyPI.

```text
Collecting example-package-YOUR-USERNAME-HERE
  Downloading https://test-files.pythonhosted.org/packages/.../example_package_YOUR_USERNAME_HERE_0.0.1-py3-none-any.whl
Installing collected packages: example_package_YOUR_USERNAME_HERE
Successfully installed example_package_YOUR_USERNAME_HERE-0.0.1
```

--------------------------------

### Example build-details.json structure

Source: https://packaging.python.org/en/latest/specifications/build-details

A sample JSON file demonstrating the schema for build-specific Python installation details.

```json
 1{
 2  "schema_version": "1.0",
 3  "base_prefix": "/usr",
 4  "base_interpreter": "/usr/bin/python",
 5  "platform": "linux-x86_64",
 6  "language": {
 7    "version": "3.14",
 8    "version_info": {
 9      "major": 3,
10      "minor": 14,
11      "micro": 0,
12      "releaselevel": "alpha",
13      "serial": 0
14    }
15  },
16  "implementation": {
17    "name": "cpython",
18    "version": {
19      "major": 3,
20      "minor": 14,
21      "micro": 0,
22      "releaselevel": "alpha",
23      "serial": 0
24    },
25    "hexversion": 51249312,
26    "cache_tag": "cpython-314",
27    "_multiarch": "x86_64-linux-gnu"
28  },
29  "abi": {
30    "flags": ["t", "d"],
31    "extension_suffix": ".cpython-314-x86_64-linux-gnu.so",
32    "stable_abi_suffix": ".abi3.so"
33  },
34  "suffixes": {
35    "source": [".py"],
36    "bytecode": [".pyc"],
37    "optimized_bytecode": [".pyc"],
38    "debug_bytecode": [".pyc"],
39    "extensions": [".cpython-314-x86_64-linux-gnu.so", ".abi3.so", ".so"]
40  },
41  "libpython": {
42    "dynamic": "/usr/lib/libpython3.14.so.1.0",
43    "dynamic_stableabi": "/usr/lib/libpython3.so",
44    "static": "/usr/lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a",
45    "link_extensions": true
46  },
47  "c_api": {
48    "headers": "/usr/include/python3.14",
49    "pkgconfig_path": "/usr/lib/pkgconfig"
50  }
51}
```

--------------------------------

### Build and Serve Python Packaging Guide Locally

Source: https://packaging.python.org/en/latest/contribute

Build the guide and serve it via an HTTP server. The guide will be accessible at http://localhost:8000.

```shell
nox -s preview

```

--------------------------------

### Example usage of pipx with cowsay

Source: https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools

Demonstration of installing the cowsay package and executing the cowsay command.

```bash
$ pipx install cowsay
  installed package cowsay 6.1, installed using Python 3.12.2
  These apps are now globally available
    - cowsay
done! ✨ 🌟 ✨
$ cowsay -t moo
  ___
< moo >
  ===
        \
         \
           ^__^
           (oo)\_______
           (__)\       )\/\
               ||     ||
               ||----w |
```

--------------------------------

### Install from local source tree

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Perform a standard installation from a local directory.

```bash
python3 -m pip install <path>
```

```bash
py -m pip install <path>
```

--------------------------------

### Install a package

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Basic command to install a library from PyPI.

```bash
python3 -m pip install requests
```

```bash
py -m pip install requests
```

--------------------------------

### Verify pip installation output on Unix/macOS

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Example output showing the version and location of the installed pip package.

```text
pip 23.3.1 from .../.venv/lib/python3.9/site-packages (python 3.9)
```

--------------------------------

### Verify pip installation output on Windows

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Example output showing the version and location of the installed pip package on Windows.

```text
pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4)
```

--------------------------------

### Install the build package

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools

Install the build tool to enable the creation of distributions.

```bash
python3 -m pip install build
```

```bash
py -m pip install build
```

--------------------------------

### Install Nox for Local Guide Building

Source: https://packaging.python.org/en/latest/contribute

Install or upgrade nox using pip. This is a prerequisite for building the guide locally.

```shell
python -m pip install --user nox

```

--------------------------------

### Pipenv installation output

Source: https://packaging.python.org/en/latest/tutorials/managing-dependencies

Example console output showing the creation of a virtual environment and the installation of requested packages.

```text
Creating a Pipfile for this project...
Creating a virtualenv for this project...
Using base prefix '/usr/local/Cellar/python3/3.6.2/Frameworks/Python.framework/Versions/3.6'
New python executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python3.6
Also creating executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python
Installing setuptools, pip, wheel...done.

Virtualenv location: ~/.local/share/virtualenvs/tmp-agwWamBd
Installing requests...
Collecting requests
  Using cached requests-2.18.4-py2.py3-none-any.whl
Collecting idna<2.7,>=2.5 (from requests)
  Using cached idna-2.6-py2.py3-none-any.whl
Collecting urllib3<1.23,>=1.21.1 (from requests)
  Using cached urllib3-1.22-py2.py3-none-any.whl
Collecting chardet<3.1.0,>=3.0.2 (from requests)
  Using cached chardet-3.0.4-py2.py3-none-any.whl
Collecting certifi>=2017.4.17 (from requests)
  Using cached certifi-2017.7.27.1-py2.py3-none-any.whl
Installing collected packages: idna, urllib3, chardet, certifi, requests
Successfully installed certifi-2017.7.27.1 chardet-3.0.4 idna-2.6 requests-2.18.4 urllib3-1.22

Adding requests to Pipfile's [packages]...
```

--------------------------------

### Generated Script Wrapper Example

Source: https://packaging.python.org/en/latest/specifications/entry-points

This represents the logic generated by install tools when an entry point is defined as mycmd = mymod:main.

```python
import sys
from mymod import main
sys.exit(main())
```

--------------------------------

### Pre-build and install wheels with pip

Source: https://packaging.python.org/en/latest/guides/index-mirrors-and-caches

Use these commands to pre-build installation files into a local directory and then install them without accessing the remote index.

```bash
python3 -m pip wheel --wheel-dir=/tmp/wheelhouse SomeProject
python3 -m pip install --no-index --find-links=/tmp/wheelhouse SomeProject
```

--------------------------------

### Example EXTERNALLY-MANAGED configuration file

Source: https://packaging.python.org/en/latest/specifications/externally-managed-environments

A sample INI-style configuration file used to provide distro-specific error messages when package installation is blocked.

```ini
[externally-managed]
Error=To install Python packages system-wide, try apt install
 python3-xyz, where xyz is the package you are trying to
 install.

 If you wish to install a non-Debian-packaged Python package,
 create a virtual environment using python3 -m venv path/to/venv.
 Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
 sure you have python3-full installed.

 If you wish to install a non-Debian packaged Python application,
 it may be easiest to use pipx install xyz, which will manage a
 virtual environment for you. Make sure you have pipx installed.

 See /usr/share/doc/python3.9/README.venv for more information.
```

```ini
Error-de_DE=Wenn ist das Nunstück git und Slotermeyer?

 Ja! Beiherhund das Oder die Virtualenvironment gersput!
```

--------------------------------

### Full pyproject.toml configuration example

Source: https://packaging.python.org/en/latest/guides/writing-pyproject-toml

A comprehensive example demonstrating build system configuration, project metadata, dependencies, scripts, and entry points.

```toml
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "spam-eggs"
version = "2020.0.0"
dependencies = [
  "httpx",
  "gidgethub[httpx]>4.0.0",
  "django>2.1; os_name != 'nt'",
  "django>2.0; os_name == 'nt'",
]
requires-python = ">=3.8"
authors = [
  {name = "Pradyun Gedam", email = "pradyun@example.com"},
  {name = "Tzu-Ping Chung", email = "tzu-ping@example.com"},
  {name = "Another person"},
  {email = "different.person@example.com"},
]
maintainers = [
  {name = "Brett Cannon", email = "brett@example.com"}
]
description = "Lovely Spam! Wonderful Spam!"
readme = "README.rst"
license = "MIT"
license-files = ["LICEN[CS]E.*"]
keywords = ["egg", "bacon", "sausage", "tomatoes", "Lobster Thermidor"]
classifiers = [
  "Development Status :: 4 - Beta",
  "Programming Language :: Python"
]

[project.optional-dependencies]
gui = ["PyQt5"]
cli = [
  "rich",
  "click",
]

[project.urls]
Homepage = "https://example.com"
Documentation = "https://readthedocs.org"
Repository = "https://github.com/me/spam.git"
"Bug Tracker" = "https://github.com/me/spam/issues"
Changelog = "https://github.com/me/spam/blob/master/CHANGELOG.md"

[project.scripts]
spam-cli = "spam:main_cli"

[project.gui-scripts]
spam-gui = "spam:main_gui"

[project.entry-points."spam.magical"]
tomatoes = "spam:main_tomatoes"
```

--------------------------------

### Install a package from source

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Install a package from a local directory or in editable mode for development.

```bash
cd google-auth
python3 -m pip install .
```

```bash
cd google-auth
py -m pip install .
```

```bash
python3 -m pip install --editable .
```

```bash
py -m pip install --editable .
```

--------------------------------

### Install pre-release versions

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Include the --pre flag to allow installation of pre-release versions.

```bash
python3 -m pip install --pre requests
```

```bash
py -m pip install --pre requests
```

--------------------------------

### Install a version range

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Installs a version that satisfies the specified range constraints.

```bash
python3 -m pip install "SomeProject>=1,<2"
```

```bash
py -m pip install "SomeProject>=1,<2"
```

--------------------------------

### Dependency Specification Examples

Source: https://packaging.python.org/en/latest/specifications/dependency-specifiers

Examples demonstrating name-based lookups with extras and version constraints, and a minimal URL-based lookup.

```text
requests [security,tests] >= 2.8.1, == 2.8.* ; python_version < "3.7"
```

```text
pip @ https://github.com/pypa/pip/archive/1.3.1.zip#sha1=da9234ee9982d4bbb3c72346a6de940a148ea686
```

--------------------------------

### Install from version control

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Install a package directly from a git repository URL.

```bash
google-auth @ git+https://github.com/GoogleCloudPlatform/google-auth-library-python.git
```

--------------------------------

### Install Python packaging tools on openSUSE

Source: https://packaging.python.org/en/latest/guides/installing-using-linux-tools

Use zypper to install pip, setuptools, and wheel.

```bash
sudo zypper install python3-pip python3-setuptools python3-wheel
```

--------------------------------

### Install from local archive file

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Install a specific source distribution archive file directly.

```bash
python3 -m pip install ./downloads/SomeProject-1.0.4.tar.gz
```

```bash
py -m pip install ./downloads/SomeProject-1.0.4.tar.gz
```

--------------------------------

### Install from local archives

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Install from a local file or a directory of archives without using PyPI.

```bash
python3 -m pip install requests-2.18.4.tar.gz
```

```bash
py -m pip install requests-2.18.4.tar.gz
```

```bash
python3 -m pip install --no-index --find-links=/local/dir/ requests
```

```bash
py -m pip install --no-index --find-links=/local/dir/ requests
```

--------------------------------

### Install build tool

Source: https://packaging.python.org/en/latest/tutorials/packaging-projects

Install the latest version of PyPA's build tool.

```bash
python3 -m pip install --upgrade build
```

```bash
py -m pip install --upgrade build
```

--------------------------------

### Install package with pipx

Source: https://packaging.python.org/en/latest/guides/creating-command-line-tools

Installs the current directory as a command line tool.

```bash
$ cd path/to/greetings/
$ pipx install .
```

--------------------------------

### Build Python Packaging Guide Locally

Source: https://packaging.python.org/en/latest/contribute

Run this shell command in the project's root folder to build the guide locally. The HTML output will be in the ./build/html directory.

```shell
nox -s build

```

--------------------------------

### Install and run packages with pipx

Source: https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools

General syntax for installing a package and executing its provided applications.

```bash
$ pipx install PACKAGE
$ PACKAGE_APPLICATION [ARGS]
```

--------------------------------

### Install Python packaging tools on Arch Linux

Source: https://packaging.python.org/en/latest/guides/installing-using-linux-tools

Use pacman to install pip.

```bash
sudo pacman -S python-pip
```

--------------------------------

### Verify package installation

Source: https://packaging.python.org/en/latest/tutorials/packaging-projects

Import the package and execute a function to confirm it is installed and functioning as expected.

```python
>>> from example_package_YOUR_USERNAME_HERE import example
>>> example.add_one(2)
3
```

--------------------------------

### Install packages from a requirements file

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Use the -r flag to install all packages listed in a requirements file.

```bash
python3 -m pip install -r requirements.txt
```

```bash
py -m pip install -r requirements.txt
```

--------------------------------

### Install from VCS in editable mode

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Installs a package from a version control system in editable mode.

```bash
python3 -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git          # from git
python3 -m pip install -e SomeProject @ hg+https://hg.repo/some_pkg                # from mercurial
python3 -m pip install -e SomeProject @ svn+svn://svn.repo/some_pkg/trunk/         # from svn
python3 -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git@feature  # from a branch
```

```bash
py -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git          # from git
py -m pip install -e SomeProject @ hg+https://hg.repo/some_pkg                # from mercurial
py -m pip install -e SomeProject @ svn+svn://svn.repo/some_pkg/trunk/         # from svn
py -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git@feature  # from a branch
```

--------------------------------

### Comprehensive version combination example

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

Example covering various combinations of development, pre-release, post-release, and local segments.

```text
1.dev0
1.0.dev456
1.0a1
1.0a2.dev456
1.0a12.dev456
1.0a12
1.0b1.dev456
1.0b2
1.0b2.post345.dev456
1.0b2.post345
1.0rc1.dev456
1.0rc1
1.0
1.0+abc.5
1.0+abc.7
1.0+5
1.0.post456.dev34
1.0.post456
1.0.15
1.1.dev1
```

--------------------------------

### Twine upload output example

Source: https://packaging.python.org/en/latest/tutorials/packaging-projects

Example console output after successfully uploading packages to TestPyPI.

```text
Uploading distributions to https://test.pypi.org/legacy/
Enter your API token:
Uploading example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.2/8.2 kB • 00:01 • ?
Uploading example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.8/6.8 kB • 00:00 • ?
```

--------------------------------

### Example of a version specifier

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

A basic example showing multiple version clauses separated by commas.

```text
~= 0.9, >= 1.0, != 1.3.4.*, < 2.0
```

--------------------------------

### Configure setup.py for README

Source: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme

Example of reading a README.md file and setting the long_description and long_description_content_type in setup.py.

```python
from setuptools import setup

# read the contents of your README file
from pathlib import Path
this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
    name='an_example_package',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)
```

--------------------------------

### Handle dynamic metadata in setup.py

Source: https://packaging.python.org/en/latest/guides/modernize-setup-py-project

Example of a legacy setup.py file using a dynamic version calculation.

```python
import setuptools
import some_build_toolkit

def get_version():
    version = some_build_toolkit.compute_version()
    return version

setuptools.setup(
    name="my-project",
    version=get_version(),
)
```

--------------------------------

### List available setup.py commands

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools

Run this command to view all available packaging tasks provided by setup.py.

```bash
python3 setup.py --help-commands
```

--------------------------------

### Example entry_points.txt Content

Source: https://packaging.python.org/en/latest/specifications/entry-points

Demonstrates the structure of entry point groups, including standard object references and those with optional extras.

```ini
[console_scripts]
foo = foomod:main
# One which depends on extras:
foobar = foomod:main_bar [bar,baz]

# pytest plugins refer to a module, so there is no ':obj'
[pytest11]
nbval = nbval.plugin
```

--------------------------------

### Configure setup.py for pkg_resources

Source: https://packaging.python.org/en/latest/guides/packaging-namespace-packages

Example of using the namespace_packages argument in setup.py.

```python
from setuptools import find_packages, setup

setup(
    name='mynamespace-subpackage-a',
    ...
    packages=find_packages()
    namespace_packages=['mynamespace']
)
```

--------------------------------

### Example RECORD file content

Source: https://packaging.python.org/en/latest/specifications/recording-installed-packages

A sample CSV-formatted RECORD file listing installed files, their SHA-256 hashes, and file sizes.

```csv
/usr/bin/black,sha256=iFlOnL32lIa-RKk-MDihcbJ37wxmRbE4xk6eVYVTTeU,220
../../../bin/blackd,sha256=lCadt4mcU-B67O1gkQVh7-vsKgLpx6ny1le34Jz6UVo,221
__pycache__/black.cpython-38.pyc,,
__pycache__/blackd.cpython-38.pyc,,
black-19.10b0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
black-19.10b0.dist-info/licenses/LICENSE,sha256=nAQo8MO0d5hQz1vZbhGqqK_HLUqG1KNiI9erouWNbgA,1080
black-19.10b0.dist-info/METADATA,sha256=UN40nGoVVTSpvLrTBwNsXgZdZIwoKFSrrDDHP6B7-A0,58841
black-19.10b0.dist-info/RECORD,,
black.py,sha256=45IF72OgNfF8WpeNHnxV2QGfbCLubV5Xjl55cI65kYs,140161
blackd.py,sha256=JCxaK4hLkMRwVfZMj8FRpRRYC0172-juKqbN22bISLE,6672
blib2to3/__init__.py,sha256=9_8wL9Scv8_Cs8HJyJHGvx1vwXErsuvlsAqNZLcJQR0,8
blib2to3/__pycache__/__init__.cpython-38.pyc,,
blib2to3/__pycache__/pygram.cpython-38.pyc,sha256=zpXgX4FHDuoeIQKO_v0sRsB-RzQFsuoKoBYvraAdoJw,1512
blib2to3/__pycache__/pytree.cpython-38.pyc,sha256=LYLplXtG578ZjaFeoVuoX8rmxHn-BMAamCOsJMU1b9I,24910
blib2to3/pygram.py,sha256=mXpQPqHcamFwch0RkyJsb92Wd0kUP3TW7d-u9dWhCGY,2085
blib2to3/pytree.py,sha256=RWj3IL4U-Ljhkn4laN0C3p7IRdfvT3aIRjTV-x9hK1c,28530
```

--------------------------------

### Version matching examples for 1.1.post1

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

Demonstrates how strict equality and prefix matching (.*) behave with the version 1.1.post1.

```text
== 1.1        # Not equal, so 1.1.post1 does not match clause
== 1.1.post1  # Equal, so 1.1.post1 matches clause
== 1.1.*      # Same prefix, so 1.1.post1 matches clause
```

--------------------------------

### Install in editable mode without dependencies

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools

Use the --no-deps flag to install the project in editable mode while skipping the installation of any declared dependencies.

```bash
python3 -m pip install -e . --no-deps
```

--------------------------------

### Install data files outside packages

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools

Use data_files to install files to specific directories outside of the Python package structure, relative to the installation prefix.

```python
data_files=[('my_data', ['data/data_file'])],
```

--------------------------------

### Minimalist setup.py for compatibility

Source: https://packaging.python.org/en/latest/guides/modernize-setup-py-project

A minimal setup.py file to satisfy legacy processes that require its existence.

```python
import setuptools

setuptools.setup()
```

--------------------------------

### Run tool with simplified syntax

Source: https://packaging.python.org/en/latest/guides/creating-command-line-tools

Executes the tool using the configured entry point.

```bash
$ pipx run . --doctor
```

--------------------------------

### Version matching examples for 1.1a1

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

Demonstrates how prefix matching behaves with pre-release segments in version 1.1a1.

```text
== 1.1        # Not equal, so 1.1a1 does not match clause
== 1.1a1      # Equal, so 1.1a1 matches clause
== 1.1.*      # Same prefix, so 1.1a1 matches clause if pre-releases are requested
```

--------------------------------

### Install a specific version of a package

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Targets an exact version of the package for installation.

```bash
python3 -m pip install "SomeProject==1.4"
```

```bash
py -m pip install "SomeProject==1.4"
```

--------------------------------

### Configure multiple repositories with tokens

Source: https://packaging.python.org/en/latest/specifications/pypirc

A complete example including PyPI, TestPyPI, and a private repository configuration.

```ini
[distutils]
index-servers =
    pypi
    testpypi
    private-repository

[pypi]
username = __token__
password = <PyPI token>

[testpypi]
username = __token__
password = <TestPyPI token>

[private-repository]
repository = <private-repository URL>
username = <private-repository username>
password = <private-repository password>
```

--------------------------------

### Configure License Files in setup.cfg

Source: https://packaging.python.org/en/latest/guides/licensing-examples-and-user-scenarios

Configuration for license metadata using the legacy setup.cfg format.

```ini
[metadata]
license = MIT AND (Apache-2.0 OR BSD-2-Clause)
license_files =
    LICENSE
    setuptools/_vendor/packaging/LICENSE
    setuptools/_vendor/packaging/LICENSE.APACHE
    setuptools/_vendor/packaging/LICENSE.BSD
```

--------------------------------

### Install from custom repository index

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Use a helper application to serve packages and point pip to it using the --extra-index-url flag.

```bash
./s3helper --port=7777
python -m pip install --extra-index-url http://localhost:7777 SomeProject
```

--------------------------------

### Install the latest version of a package

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Installs the most recent version of the specified project from PyPI.

```bash
python3 -m pip install "SomeProject"
```

```bash
py -m pip install "SomeProject"
```

--------------------------------

### Version matching examples for 1.1

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

Demonstrates how zero padding and strict equality affect matching for version 1.1.

```text
== 1.1        # Equal, so 1.1 matches clause
== 1.1.0      # Zero padding expands 1.1 to 1.1.0, so it matches clause
== 1.1.dev1   # Not equal (dev-release), so 1.1 does not match clause
== 1.1a1      # Not equal (pre-release), so 1.1 does not match clause
== 1.1.post1  # Not equal (post-release), so 1.1 does not match clause
== 1.1.*      # Same prefix, so 1.1 matches clause
```

--------------------------------

### Compatible release examples

Source: https://packaging.python.org/en/latest/specifications/version-specifiers

Demonstrates how compatible release clauses map to equivalent comparison clauses.

```text
~= 2.2
>= 2.2, == 2.*

~= 1.4.5
>= 1.4.5, == 1.4.*
```

--------------------------------

### Install pypinfo CLI tool

Source: https://packaging.python.org/en/latest/guides/analyzing-pypi-package-downloads

Installs the pypinfo command-line utility via pip.

```bash
python3 -m pip install pypinfo
```

--------------------------------

### Declare build system dependencies

Source: https://packaging.python.org/en/latest/specifications/pyproject-toml

Example of the [build-system] table requiring setuptools for project builds.

```toml
[build-system]
# Minimum requirements for the build system to execute.
requires = ["setuptools"]
```

--------------------------------

### Valid License Expression Examples

Source: https://packaging.python.org/en/latest/guides/licensing-examples-and-user-scenarios

Various examples of valid license expression strings.

```text
License-Expression: MIT
License-Expression: BSD-3-Clause
License-Expression: MIT AND (Apache-2.0 OR BSD-2-Clause)
License-Expression: MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)
License-Expression: GPL-3.0-only WITH Classpath-Exception-2.0 OR BSD-3-Clause
License-Expression: LicenseRef-Public-Domain OR CC0-1.0 OR Unlicense
License-Expression: LicenseRef-Proprietary
License-Expression: LicenseRef-Custom-License
```

--------------------------------

### Install from alternate index

Source: https://packaging.python.org/en/latest/tutorials/installing-packages

Installs a package from a specific index URL instead of the default PyPI.

```bash
python3 -m pip install --index-url http://my.package.repo/simple/ SomeProject
```

```bash
py -m pip install --index-url http://my.package.repo/simple/ SomeProject
```

--------------------------------

### Install from alternative indexes

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Use custom indexes for package resolution.

```bash
python3 -m pip install --index-url http://index.example.com/simple/ SomeProject
```

```bash
py -m pip install --index-url http://index.example.com/simple/ SomeProject
```

```bash
python3 -m pip install --extra-index-url http://index.example.com/simple/ SomeProject
```

```bash
py -m pip install --extra-index-url http://index.example.com/simple/ SomeProject
```

--------------------------------

### Install a package with Pipenv

Source: https://packaging.python.org/en/latest/tutorials/managing-dependencies

Navigate to the project directory and install a dependency to automatically generate a Pipfile.

```bash
cd myproject
pipenv install requests
```

--------------------------------

### Freeze installed dependencies

Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments

Export the current list of installed packages and their versions to standard output.

```bash
python3 -m pip freeze
```

```bash
py -m pip freeze
```

--------------------------------

### Install Python packaging tools on Debian/Ubuntu

Source: https://packaging.python.org/en/latest/guides/installing-using-linux-tools

Update repository lists and install venv and pip.

```bash
sudo apt update
sudo apt install python3-venv python3-pip
```

--------------------------------

### Specify dependencies in setup.py

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools

Define the minimal dependencies required for the project to run, which pip will install automatically.

```python
install_requires=['peppercorn'],
```

--------------------------------

### Configure Namespace Packages in setup.cfg

Source: https://packaging.python.org/en/latest/guides/packaging-namespace-packages

Configuration for finding namespace packages using setup.cfg.

```ini
[options]
package_dir =
    =src
packages = find_namespace:

[options.packages.find]
where = src
```

--------------------------------

### Install pipx

Source: https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools

Commands to install pipx and configure the system PATH for Unix/macOS and Windows environments.

```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

```bash
py -m pip install --user pipx
py -m pipx ensurepath
```
Tokens:
Raw