Skip to content

Commit 88b7a29

Browse files
committed
Note on how to specify dependencies from github
1 parent 9f8464e commit 88b7a29

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

content/packaging.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,29 @@ This is how ``pyproject.toml`` looks:
109109
:caption: pyproject.toml
110110
:emphasize-lines: 13-15
111111

112-
.. seealso::
113-
114-
pyOpenSci tutorial on
115-
`pyproject.toml metadata <https://www.pyopensci.org/python-package-guide/tutorials/pyproject-toml.html>`__
116-
117112
Note how our package requires ``scipy`` and we decided to not pin the version
118113
here (see :ref:`version_pinning`).
119114

120115
Now we have all the building blocks to test a local pip install. This is a good
121116
test before trying to upload a package to PyPI or test-PyPI
122117
(see :ref:`pypi`)
123118

119+
.. note::
120+
121+
Sometime you need to rely on unreleased, development versions as
122+
dependencies and this is also possible. For example, to use the
123+
latest ``xarray`` you could add::
124+
125+
dependencies = [
126+
"scipy",
127+
"xarray @ https://github.com/pydata/xarray/archive/main.zip"
128+
]
129+
130+
.. seealso::
131+
- `pip requirement specifiers <https://pip.pypa.io/en/stable/reference/requirement-specifiers/>`__
132+
- pyOpenSci tutorial on
133+
`pyproject.toml metadata <https://www.pyopensci.org/python-package-guide/tutorials/pyproject-toml.html>`__
134+
124135

125136

126137
Exercises 1

0 commit comments

Comments
 (0)