Documented the use of the "subdirectory" parameter (python-poetry#5949)

* Documented the use of the "subdirectory" parameter * Moved the subdir documentation up * Update docs/dependency-specification.md Co-authored-by: Mathieu Kniewallner <[email protected]> * Added @mkniewallner editorial changes Co-authored-by: Mathieu Kniewallner <[email protected]> * Fixed final URL Co-authored-by: Mathieu Kniewallner <[email protected]> Co-authored-by: Mathieu Kniewallner <[email protected]>
efugier · Aug 4, 2022 · a800474 · a800474
1 parent 7de044d
commit a800474
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/dependency-specification.md b/docs/dependency-specification.md
@@ -145,6 +145,20 @@ flask = { git = "https://github.com/pallets/flask.git", rev = "38eb5d3b" }
 numpy = { git = "https://github.com/numpy/numpy.git", tag = "v0.13.2" }
 ```
 
+In cases where the package you want to install is located in a subdirectory of the VCS repository, you can use the `subdirectory` option, similarly to what [pip](https://pip.pypa.io/en/stable/topics/vcs-support/#url-fragments) provides:
+
+```toml
+[tool.poetry.dependencies]
+# Install a package named `subdir_package` from a folder called `subdir` within the repository
+subdir_package = { git = "https://github.com/myorg/mypackage_with_subdirs.git", subdirectory = "subdir" }
+```
+
+with the corresponding `add` call:
+
+```bash
+poetry add "https://github.com/myorg/mypackage_with_subdirs.git#subdirectory=subdir"
+```
+
 To use an SSH connection, for example in the case of private repositories, use the following example syntax:
 
 ```toml