This repository contains a simple demo package that makes use of a default extras to install recommended dependencies by default.

It is an example usage of the specification described in the PEP draft at python/peps#4198.

Note on the pyproject.toml key name. This demo (and the setuptools fork it depends on) uses default-optional-dependencies in the [project] table. The current PEP 771 draft instead uses default-optional-dependency-keys. Since the PEP is still subject to change, the demo is intentionally left on the older spelling for now, and will be updated once the key name is finalized. The Default-Extra: core-metadata field consumed by pip already matches the PEP and is unaffected.

The demo package comes in two flavors:

• Flavor A: Built exclusively with pyproject.toml
• Flavor B: Built mixing pyproject.toml and setup.py

Aside of that, both have the exact same logic, exact same behavior:

1. Install the PEP 771 Package:

# 1. Create a virtualenv 
# WARNING: Installing PEP 771 overwrites a bunch of standard python library.
# Do not install this in your main python environment.
virtualenv .venv
source .venv/bin/activate

# 2. Set the extra index to the WheelNext Static Wheel Server: MockHouse
pip config set --site global.index-url https://mockhouse.wheelnext.dev/pep-771/
pip config set --site global.extra-index-url https://pypi.org/simple/
>>> Writing to /path/to/venv/pip.conf

# 2. Install the PEP 771 Metapackage that will give you the modified libraries:
# - setuptools
# - pip
# - importlib_metadata
# - validate-pyproject
pip install pep-771

# 3. Let's verify everything is good:
pip --version
>>> pip 25.0.dev0+pep-771 from ...  # <=============== Check you can see `+pep-771`

pip freeze | grep setuptools
>>> setuptools @ git+https://github.com/wheelnext/setuptools.git@...

2. Install the demo package:

# -------------------- Then choose one of the followings -------------------- #

# ~~~~~~~~ pep-771-demo-a ~~~~~~~~ #

# should install pep-771-demo-a AND the default `flask` extra
pip install --dry-run pep-771-demo-a
>>> Would install Flask-X.Y.Z ... pep-771-demo-a-1.0.0

# should install pep-771-demo-a AND the explicit `flask` extra
pip install --dry-run pep-771-demo-a[flask]
>>> Would install Flask-X.Y.Z ... pep-771-demo-a-1.0.0

# will install pep-771-demo-a AND the explicit `fastapi` extra - no default "flask"
pip install --dry-run pep-771-demo-a[fastapi]
>>> Would install fastapi-X.Y.Z ... pep-771-demo-a-1.0.0

# will install only pep-771-demo-a (PEP 771 `[]` opts out of default extras)
pip install --dry-run pep-771-demo-a[]
>>> Would install pep-771-demo-a-1.0.0

# ~~~~~~~~ pep-771-demo-b ~~~~~~~~ #

# should install pep-771-demo-b AND the default `flask` extra
pip install --dry-run pep-771-demo-b
>>> Would install Flask-X.Y.Z ... pep-771-demo-b-1.0.0

# should install pep-771-demo-b AND the explicit `flask` extra
pip install --dry-run pep-771-demo-b[flask]
>>> Would install Flask-X.Y.Z ... pep-771-demo-b-1.0.0

# will install pep-771-demo-b AND the explicit `fastapi` extra - no default "flask"
pip install --dry-run pep-771-demo-b[fastapi]
>>> Would install fastapi-X.Y.Z ... pep-771-demo-b-1.0.0

# will install only pep-771-demo-b (PEP 771 `[]` opts out of default extras)
pip install --dry-run pep-771-demo-b[]
>>> Would install pep-771-demo-b-1.0.0