Skip to main content

PDM plugin that allows additional directories listed in pyproject.toml to be added to environment PATH

Project description

pdm-bin-dir

CI PyPI version Python versions License: MIT

pdm-bin-dir is a PDM plugin that automatically prepends additional project directories to PATH when running commands via PDM. This lets you place helper scripts alongside your project and run them as plain commands — no prefix or activation needed.

Requirements

  • Python 3.10 or later
  • PDM 2.0 or later

Installation

Install the plugin into PDM's own environment:

pdm self add pdm-bin-dir

Usage

The plugin is opt-in per project: it has no effect unless [tool.pdm.plugin.bin-dir] is present in the project's pyproject.toml. Once configured, the listed directories are prepended to PATH before every pdm run … invocation.

Configuration

Add to your project's pyproject.toml:

[tool.pdm.plugin.bin-dir]
dirs = ["bin", "scripts"]

Paths are relative to the project root. Absolute paths are also accepted. The default is an empty list (no directories added).

pdm bin-dir command

The plugin registers a bin-dir sub-command for inspecting and changing the configuration:

# Show current configured directories (JSON array)
pdm bin-dir show

# Replace the list
pdm bin-dir set bin scripts

# Append to the list (duplicates are silently skipped)
pdm bin-dir add tools

Changes made via set / add are written back to pyproject.toml.

License

MIT. See LICENSE.


For development and release workflow documentation, see CONTRIBUTING.md.

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_bin_dir-1.0.6.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pdm_bin_dir-1.0.6-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file pdm_bin_dir-1.0.6.tar.gz.

File metadata

  • Download URL: pdm_bin_dir-1.0.6.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pdm_bin_dir-1.0.6.tar.gz
Algorithm Hash digest
SHA256 d06390fb56745415b0c76b2df0a616490247a5179dbaba438a24714f7a7ca75f
MD5 14b9612923d8e67d6c08c6baa608334a
BLAKE2b-256 1a90c5babca3faea700a103e84a583c1e89f0255d904283b40002354e3e47b46

See more details on using hashes here.

Provenance

The following attestation bundles were made for pdm_bin_dir-1.0.6.tar.gz:

Publisher: publish.yml on mckelvie-org/pdm-bin-dir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pdm_bin_dir-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: pdm_bin_dir-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pdm_bin_dir-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 058a0e01fbb93dff277a36e65bfbe46815ed4f19f9fac30d2691c14f2b85762a
MD5 6c9ee12886b0662834081ecb8fa8fa1e
BLAKE2b-256 e1889326aba7993c824ce5f9a585fc480221cecc447947fd6c265378969e7a8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pdm_bin_dir-1.0.6-py3-none-any.whl:

Publisher: publish.yml on mckelvie-org/pdm-bin-dir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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