Skip to main content

A PDM plugin to sync the exported files with the project file

Project description

pdm-autoexport

Github Actions PyPI pdm-managed

A PDM plugin to sync the exported files with the project file.

Installation

Install the plugin with PDM CLI:

pdm plugin add pdm-autoexport

Or using pipx inject:

pipx inject pdm pdm-autoexport

Usage

Configure the requirement mapping in pyproject.toml:

[[tool.pdm.autoexport]]
filename = "requirements/prod.txt"
groups = ["default"]

[[tool.pdm.autoexport]]
filename = "setup.py"
format = "setuppy"

Then the requirement files will be synced every time when the lock file is updated.

Configuration

The configuration is an array of table [[tool.pdm.autoexport]] where each item may contain the following keys:

  • filename (required): The path to the exported file.
  • groups (optional, default: ["default"]): The groups of optional dependencies or dev dependency groups of PDM to sync with.
  • format (optional, default: "requirements"): The format of the exported file, same as the --format option to the pdm export command. Only requirements and setuppy are supported.
  • without-hashes (optional, default: false): Whether to remove the hashes from the exported file. Only applicable to requirements format.

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-autoexport-0.1.1.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

pdm_autoexport-0.1.1-py3-none-any.whl (4.0 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