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

Documented the use of the "subdirectory" parameter #5949

Merged
merged 5 commits into from
Aug 2, 2022
Merged

Documented the use of the "subdirectory" parameter #5949

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bb5a1a7
Documented the use of the "subdirectory" parameter
AKuederle Jul 4, 2022
67bf570
Moved the subdir documentation up
AKuederle Jul 29, 2022
a3a4d51
Update docs/dependency-specification.md
AKuederle Aug 1, 2022
7635004
Added @mkniewallner editorial changes
AKuederle Aug 1, 2022
52752e7
Fixed final URL
AKuederle Aug 2, 2022
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
14 changes: 14 additions & 0 deletions docs/dependency-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,20 @@ poetry config http-basic.git-org-project username token
poetry add git+https://github.com/org/project.git
```

In cases where the package you want to install is located in a subdirectory of the VCS repo, you can use the subdirectory option:
AKuederle marked this conversation as resolved.
Show resolved Hide resolved

```toml
[tool.poetry.dependencies]
# Install a package named `subdir_package` from a folder called `subdir` within the repo
subdir_package = { git = "https://github.com/mypackage_with_subdirs.git", subdirectory = "subdir" }
```

When using `poetry add` to achive the same options, you can use the same URL formatting that is also supported by [pip](https://pip.pypa.io/en/stable/topics/vcs-support/#url-fragments).

```bash
poetry add "https://github.com/mypackage_with_subdirs.git#subdirectory=subdir"
```

{{% note %}}
With Poetry 1.2 releases, the default git client used is [Dulwich](https://www.dulwich.io/).

Expand Down