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

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

Merged
merged 2 commits into from
Jan 22, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95ca88b
Added missing mention of type = "file" reference in [tool.poetry.scri…
RobertoRoos Jul 23, 2024
12bd0d8
Added notice about type file + Review comments
RobertoRoos Jan 16, 2025
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
13 changes: 12 additions & 1 deletion docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,7 @@ for more information on other keys and specifying version ranges.
### scripts

**Deprecated**: Use `project.scripts` instead.
Use `[tool.poetry.scripts]` only for scripts of type "file", because those are not supported in `[project.scripts]`.

This section describes the scripts or executables that will be installed when installing the package

Expand All @@ -737,7 +738,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
RobertoRoos marked this conversation as resolved.
Show resolved Hide resolved
[tool.poetry.scripts]
my_executable = { reference = "some_binary.exe", type = "file" }
```

This tells Poetry to include the specified file, relative to your project directory, in distribution builds. It will then be copied to the appropriate installation directory for your operating system when your package is installed.

* 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
Loading