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

(Docs) Added type = "file" reference [tool.poetry.scripts] #9572

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

(Docs) Added type = "file" reference [tool.poetry.scripts] #9572

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: 11 additions & 1 deletion docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,17 @@ Here, we will have the `my_package_cli` script installed which will execute the
When a script is added or updated, run `poetry install` to make them available in the project's virtualenv.
{{% /note %}}

### extras
```toml
[tool.poetry.scripts]
my_executable = { reference = "some_binary.exe", type = "file" }
```

With this configuration, Poetry will look for the referenced file in the active project and then copy it to the OS installation directory.

* On Windows the file is placed in the `Scripts/` directory.
* On *nix system the file is placed in the `bin/` directory.

## `extras`

**Deprecated**: Use `project.optional-dependencies` instead.

Expand Down