Skip to content

docs: explain CLI, GUI, and plugin entry point placeholders #2458

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

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

docs: explain CLI, GUI, and plugin entry point placeholders #2458

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
6 changes: 6 additions & 0 deletions docs/config/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ After installing projects that define CLI scripts, each key will be available al
cli-name = "pkg.subpkg:func"
```

Replace `cli-name` with the command name you want to expose and `pkg.subpkg:func` with the import path of the function to call.

Using the above example, running `cli-name` would essentially execute the following Python script:

```python
Expand All @@ -232,8 +234,12 @@ GUI scripts are exactly the same as CLI scripts except on Windows, where they ar
gui-name = "pkg.subpkg:func"
```

Replace `gui-name` with the command name you want to expose and `pkg.subpkg:func` with the import path of the function to call.

### Plugins

Replace `plugin-namespace` with the entry point group used by the code that discovers your plugins. The consuming framework may prescribe this group name. Replace `plugin-name1` and `plugin-name2` with the names of your plugins, and the values with their import paths. An import path can refer to a module, like `pkg.subpkg1`, or an object within a module, like `pkg.subpkg2:func`.

```toml tab="pyproject.toml"
[project.entry-points.plugin-namespace]
plugin-name1 = "pkg.subpkg1"
Expand Down
Loading