Clarify format of `requires` and `test_requires` settings - Githubissues

beeware / briefcase

Tools to support converting a Python project into a standalone native application.

https://briefcase.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

2.48k stars 352 forks source link

Clarify format of `requires` and `test_requires` settings #1786

Closed freakboy3742 closed 1 month ago

freakboy3742 commented 1 month ago

What is the problem or limitation you are having?

The documentation describes the existence of the requires and test requires settings, but doesn't indicate the format these settings should take.

Describe the solution you'd like

The documentation for requires and test_requires should indicate that any PEP 508 version specifier is legal, and provide some explicit examples:

Bare pacakge name
Package name with version specifier
Git repository
Local directory
Local wheel file.

Describe alternatives you've considered

-

Additional context

-

spa51273 commented 1 month ago

pycon24, taking a look at this. Thanks!