Skip to main content

PDM plugin that save your requirements as wheels, similar to pip-wheel

Project description

pdm-wheel

Tests pypi version License Python version pre-commit.ci status pdm-managed Ruff Code style: black

A PDM plugin that save your requirements as wheels, similar to pip wheel

Requirements

pdm-wheel requires Python >=3.10, and PDM >=2.4.1

Installation

You can install the plugin directly by:

pdm plugin add pdm-wheel

If you have installed PDM with the recommended tool pipx, add this plugin by:

pipx inject pdm pdm-wheel

Or if you have installed PDM with pip install --user pdm, install with pip to the user site:

python -m pip install --user pdm-wheel

Otherwise, install pdm-wheel to the same place where PDM is located.

Usage

pdm wheel [common-options] [dependencies-selection-options] [wheel-options]

💡 Check the options for your version of pdm wheel with:

pdm wheel --help

Common Options:

-h, --help

show this help message and exit

-v, --verbose

-v for detailed output and -vv for more detailed

-g, --global

Use the global project, supply the project root with -p option

-p PROJECT_PATH, --project PROJECT_PATH

Specify another path as the project root, which changes the base of pyproject.toml and __pypackages__

-L LOCKFILE, --lockfile LOCKFILE

Specify another lockfile path. Default: pdm.lock. [env var: PDM_LOCKFILE]

Dependencies Selection Options:

-G GROUP, --group GROUP

Select group of optional-dependencies or dev-dependencies (with -d). Can be supplied multiple times, use ":all" to include all groups under the same species.

--no-default

Don't include dependencies from the default group

-d, --dev

Select dev dependencies

--prod, --production

Unselect dev dependencies

Wheel Options:

-w OUTPUT, --wheel-dir OUTPUT

Specify the output directory. By default it is the current directory

Examples

# Save all dependencies (including dev deps) as wheels in the ./wheels folder
pdm wheel -w wheels
# Save all dev dependencies  as wheels in the ./wheels folder
pdm wheel -w wheels --dev
# Save all non-dev dependencies as wheels in the ./wheels folder
pdm wheel -w wheels --prod

Caveats

  1. pdm-wheel does not check whether the wheels are already built.
  2. pdm-wheel does not empty the output directory before building wheels.

Changelog

See CHANGELOG.md

Acknowledgements

pdm-wheel is inspired by pip wheel.

pdm-wheel's structure is based on frostming's pdm-packer

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdm-wheel-0.0.1.tar.gz (6.7 kB view hashes)

Uploaded Source

Built Distribution

pdm_wheel-0.0.1-py3-none-any.whl (5.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page