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

Add archives in Git to Direct URL schema #1798

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add archives in Git to Direct URL schema #1798

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions source/specifications/direct-url-data-structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,16 @@ A top-level ``subdirectory`` field MAY be present containing a directory path,
relative to the root of the VCS repository, source archive or local directory,
to specify where ``pyproject.toml`` or ``setup.py`` is located.

.. _direct-url-data-structure-archives-in-git:

Archives in Version Control
---------------------------

A top-level ``file`` field MAY be present for VCS repositories, containing the
location of an archive relative to the root of a VCS repository. The filename
of the path must be a valid distribution name. This key is mutually exclusive
with ``subdirectory``. Note that ``file`` has no PEP 508 equivalent.

.. _direct-url-data-structure-registered-vcs:

Registered VCS
Expand Down Expand Up @@ -275,6 +285,9 @@ The following JSON Schema can be used to validate the contents of ``direct_url.j
},
"resolved_revision": {
"type": "string"
},
"file": {
"type": "string"
}
},
"required": [
Expand Down