Skip to content

Commit

Permalink
Added notice about type file + Review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertoRoos authored and abn committed Jan 22, 2025
1 parent 95ca88b commit 12bd0d8
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/pyproject.md
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 @@ -742,12 +743,12 @@ When a script is added or updated, run `poetry install` to make them available i
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.
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`
### `extras`

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

Expand Down

0 comments on commit 12bd0d8

Please sign in to comment.