Pyroma is a Python library and command-line tool designed to test your project's packaging friendliness. It evaluates a Python project's metadata, structure, and configuration (e.g., `setup.py`, `pyproject.toml`) against a set of best practices to determine how well-prepared it is for distribution on PyPI. The current version is 5.0.1, with major releases occurring roughly annually and minor updates as needed.
pip install pyromaVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to programmatically use Pyroma. It creates a temporary, minimal Python project directory, runs `pyroma.ratings.run_pyroma` on it, prints the score and any messages, and then cleans up the temporary files. This pattern is useful for integrating Pyroma checks into custom scripts or CI/CD pipelines.
Update your code to pass the project's root directory: `pyroma.ratings.run_pyroma('/path/to/project_root')`. For the CLI, use `pyroma /path/to/project_root` or simply `pyroma .` from within the project's root.Ensure your environment uses Python 3.9 or newer. If you must use an older Python version, pin Pyroma to a compatible version, e.g., `pyroma<5.0.0`.
Understand Pyroma's scope as a packaging linter. Focus on addressing specific warnings related to `setup.py`, `pyproject.toml`, `README`, and package structure to improve its distribution readiness, rather than expecting it to validate application logic.
Always execute `pyroma .` from your project's root directory, or provide the full path to the root: `pyroma /path/to/my/project`.
No dependency data recorded yet.