Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify format of requires and test_requires settings #1786

Closed
freakboy3742 opened this issue May 8, 2024 · 1 comment · Fixed by #1809
Closed

Clarify format of requires and test_requires settings #1786

freakboy3742 opened this issue May 8, 2024 · 1 comment · Fixed by #1809
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start!

Comments

@freakboy3742
Copy link
Member

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
@freakboy3742 freakboy3742 added enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! documentation An improvement required in the project's documentation. labels May 8, 2024
@spa51273
Copy link
Contributor

spa51273 commented May 20, 2024 •
edited
Loading

pycon24, taking a look at this. Thanks!

spa51273 added a commit to spa51273/briefcase that referenced this issue May 20, 2024
@spa51273
issue beeware#1786 - clarify format of requires
ddbb38c
@spa51273 spa51273 mentioned this issue May 20, 2024
Merged
2 tasks
mhsmith added a commit that referenced this issue May 20, 2024
@mhsmith
Merge pull request #1809 from spa51273/docs/configuration-requires
92493e3 
issue #1786 - clarify format of requires
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

issue #1786 - clarify format of requires spa51273/briefcase
2 participants
@freakboy3742 @spa51273