Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GabDug/pdm-wheel
PDM plugin that save your requirements as wheels, similar to pip wheel
https://github.com/GabDug/pdm-wheel
pdm python
Last synced: 2 months ago
JSON representation
PDM plugin that save your requirements as wheels, similar to pip wheel
- Host: GitHub
- URL: https://github.com/GabDug/pdm-wheel
- Owner: GabDug
- License: mit
- Created: 2023-01-29T17:23:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T22:58:36.000Z (3 months ago)
- Last Synced: 2024-04-15T23:57:38.897Z (3 months ago)
- Topics: pdm, python
- Language: Python
- Homepage:
- Size: 315 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-pdm - pdm-wheel - A PDM plugin to export your dependencies wheels, mainly for CI and deployments (Plugins)
README
# pdm-wheel
[](https://github.com/GabDug/pdm-wheel/actions/workflows/ci.yml)
[](https://pypi.org/project/pdm-wheel/)
[](https://pypi.python.org/pypi/pdm-wheel)
[](https://pypi.python.org/pypi/pdm-wheel)
[](https://results.pre-commit.ci/latest/github/GabDug/pdm-wheel/main?badge_token=PzBISUnvTEeYahD7i22qiA)
[](https://pdm.fming.dev)
[](https://github.com/charliermarsh/ruff)
[](https://github.com/psf/black)
[](https://codecov.io/gh/GabDug/pdm-wheel)
A PDM plugin that save your requirements as wheels, similar to [`pip wheel`](https://pip.pypa.io/en/stable/cli/pip_wheel/)
## Use cases
- You want to build wheels for your dependencies, but don't want to use `pdm export` and `pip wheel`.
- You need to pass the wheels to a CI/CD pipeline, and don't want to build them on the CI/CD server.
- You want to install dependencies in a Docker image, but don't want to configure private repositories in the image.
## Supported versions
- Python 3.10+
- PDM 2.7.4+ (not 2.13.0 and 2.13.1)
We recommend you use the patch versions of Python and PDM.
## Installation
Install it [just like any other PDM plugin](https://pdm.fming.dev/latest/dev/write/#activate-the-plugin):
```bash
pdm self add pdm-wheel
```
If you have installed PDM with the recommended tool `pipx`, add this plugin by:
```bash
pipx inject pdm pdm-wheel
```
Or if you have installed PDM with `pip install --user pdm`, install with `pip` to the user site:
```bash
python -m pip install --user pdm-wheel
```
Optionally, you can also specify [the plugin in your project](https://pdm.fming.dev/latest/dev/write/#specify-the-plugins-in-project) `pyproject.toml`, to make it installable with `pdm install --plugins`:
```toml
[tool.pdm]
plugins = [
"pdm-wheel"
]
```
## Usage
```bash
pdm wheel [common-options] [dependencies-selection-options] [wheel-options]
```
💡 Check the options for your version of `pdm wheel` with:
```bash
pdm wheel --help
```
**Wheel Options:**
`-w OUTPUT, --wheel-dir OUTPUT`
> Specify the output directory. It will be created it it does not exists. Default is the current directory `./wheels`
> Environment variable: `PDM_WHEEL_DIR`
`--clean`
> Clean the target directory before building.
`--no-clean`
> Do not clean the target directory before building. This is the default behavior.
## Notes on lockfiles
PDM 2.8+ now saves the lockfiles with only hashes and no URL by default.
There is currently a performance overhead, as some internals expect the URL to be present, else they will try to reach the indexes to get it.
Thus, I recommend you use `pdm lock --static-urls` to have faster `pdm wheel` operations.
_Read more about this in [PDM's documentation](https://pdm.fming.dev/latest/usage/dependency/#store-static-urls-or-filenames-in-lockfile)._
## Examples
```bash
# 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.
## Changelog
See [Github Releases](https://github.com/GabDug/pdm-wheel/releases)
## Acknowledgements
`pdm-wheel` is inspired by [`pip wheel`](https://pip.pypa.io/en/stable/cli/pip_wheel/).
`pdm-wheel`'s structure is based on frostming's [`pdm-packer`](https://github.com/frostming/pdm-packer/)