Skip to content

[Python] clarify specifiers allowed for the requirements comment #727

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

Merged
merged 1 commit into from
Oct 7, 2024
Merged

[Python] clarify specifiers allowed for the requirements comment #727

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
12 changes: 8 additions & 4 deletions docs/advanced/15_dependencies_in_python/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,14 +207,18 @@ scripts locally and on Windmill. See [Developing scripts locally](../4_local_dev
### Pinning Dependencies and Requirements

If the imports are not properly analyzed, there exists an escape hatch to
override the inferred imports. One needs to head the Script with the following comment:
override the inferred imports. One needs to head the Script with the `requirements` comment followed by dependencies.
The standard pip [requirement specifiers](https://pip.pypa.io/en/stable/reference/requirement-specifiers/) are supported. Some examples:

```python
#requirements:
#dependency
#version_pinned_dependency==0.4
#dependency1[optional_module]
#dependency2>=0.40
#dependency3@git+https://github.com/myrepo/dependency3.git

import dependency
import dependency1
import dependency2
import dependency3

def main(...):
...
Expand Down
Loading