https://github.com/andriykohut/pdm-readiness

A pdm plugin to check if your project dependencies support specific Python version.
https://github.com/andriykohut/pdm-readiness

pdm pdm-plugin python

Last synced: 2 months ago
JSON representation

A pdm plugin to check if your project dependencies support specific Python version.

• Host: GitHub
• URL: https://github.com/andriykohut/pdm-readiness
• Owner: andriykohut
• License: mit
• Created: 2023-12-04T16:25:55.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2023-12-16T18:39:07.000Z (7 months ago)
• Last Synced: 2024-04-06T01:20:51.618Z (3 months ago)
• Topics: pdm, pdm-plugin, python
• Language: Python
• Homepage:
• Size: 69.3 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-pdm - pdm-readiness - A PDM plugin to check if your project dependencies support specified Python version (Plugins)

README

        
# pdm-readiness

[![PyPI version](https://badge.fury.io/py/pdm-readiness.svg)](https://pypi.org/project/pdm-readiness/)

![Github Actions](https://github.com/pdm-project/pdm/workflows/Tests/badge.svg)

A `pdm` plugin to check if your project dependencies support specific Python version.

> [!NOTE]  

> Many packages may still work just fine even when they are not listed as supported.

> This plugin only checks the metadata provided by the package authors, so it is not

> a guarantee that the package will work or not.

## Synopsis

The readiness report is divided into 4 sections:

- **Supported dependencies** - currently locked dependencies that support the target Python version.

- **Update required** - currently locked dependencies that do not support the target Python version, but have newer versions that do.

- **Unsupported dependencies** - the most recent version of the dependency does not support the target Python version.

- **Missing metadata** - the package does not provide metadata about the supported Python versions.

Plugin uses [PyPI JSON API](https://warehouse.pypa.io/api-reference/json.html) to get the metadata.

It looks at classifiers like `Programming Language :: Python :: 3.12` to determine which versions are supported.

## Installation

```sh

pdm self add pdm-readiness

```

## Usage

Run `pdm readiness ` in the root of your pdm project.

Example output:

![image](https://github.com/andriykohut/pdm-readiness/assets/3106616/60b7985f-0cc6-4124-8abe-878690a9d89a)