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.

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

issue #1786 - clarify format of requires #1809

Merged
merged 3 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1786.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Specific examples added for requires under configuration.
34 changes: 34 additions & 0 deletions docs/reference/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,9 @@ A hexadecimal RGB color value (e.g., ``#008577``) used alongside the primary
color. This setting is only used if the platform allows color modification,
otherwise it is ignored.


.. _configuration-requires-key:

``requires``
~~~~~~~~~~~~

Expand All @@ -324,6 +327,35 @@ application level, *and* platform level, the final set of requirements will be
the *concatenation* of requirements from all levels, starting from least to
most specific.

Any PEP 508 version specifier is legal. For example:

* Bare package name::

requires = ["pillow"]

* Package name with version specifier::

requires = ["pillow==9.1.0"]

* Install from source using the ``--no-binary`` entry::

requires =
["pillow==9.1.0",
"--no-binary", "pillow",
]
spa51273 marked this conversation as resolved.
Show resolved Hide resolved

* Git repository::

requires=["git+https://github.com/beeware/briefcase.git"]

* Local directory::

requires=["mysrc/myapp"]

* Local wheel file::

requires=["fullpath/wheelfile.whl"]

``revision``
~~~~~~~~~~~~

Expand Down Expand Up @@ -402,6 +434,8 @@ level, application level, *and* platform level, the final set of requirements
will be the *concatenation* of requirements from all levels, starting from least
to most specific.

See :ref:`requires <configuration-requires-key>` for examples.

``test_sources``
~~~~~~~~~~~~~~~~

Expand Down
Loading