Skip to content

Document how to require plugins #3553

@stephenfin

Description

@stephenfin

What's the problem this feature will solve?

I was in the process of opening an RFE to add a new config option allowing installation of required plugins (e.g. require tox-uv so you can rely on the uv-venv-lock-runner runner). However, upon further inspection, I now think [tox] requires should achieve just this. There is likely a gap in the docs since this wasn't obvious to me at least.

Describe the solution you'd like

I think two things should happen:

  1. We should indicate this in the docs for the requires option and the plugins doc?
  2. We should "soft-deprecate" (mark as deprecated in the docs, but continue as usual at runtime) the [tox] min_version option since [tox] requires can achieve the exact same thing

Alternative Solutions

n/a

Additional context

none.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions