Skip to content
This repository has been archived by the owner on Dec 1, 2023. It is now read-only.

Commit

Permalink
feat: update README.md (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericnordelo authored Nov 15, 2022
1 parent 52f58f5 commit e832fa9
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,21 +506,19 @@ In order for this implementation to be functional, the plugin developer must fol

```sh
# We need to specify that Click commands are entry points in the group `nile_plugins`
[tool.poetry.plugins.nile_plugins]
cli =
# <command_name> = <package_method_location>
"greet" = "nile_greet.main.greet"
[tool.poetry.plugins."nile_plugins.cli"]
# <command_name> = <package_method_location>
"greet" = "nile_greet.main.greet"
```

3. Optionally specify plugin entry points for `NileRuntimeEnvironment`. This doesn't require implementing a Click command (remove the cli entry points if not needed):

```sh
[tool.poetry.plugins.nile_plugins]
cli =
"greet" = "nile_greet.main.greet"
[tool.poetry.plugins."nile_plugins.cli"]
"greet" = "nile_greet.main.greet"

nre =
"greet" = "nile_greet.nre.greet"
[tool.poetry.plugins."nile_plugins.nre"]
"greet" = "nile_greet.nre.greet"
```

4. Done! For a better understanding of python entry points through setuptools, [check this documentation](https://setuptools.pypa.io/en/latest/userguide/entry_point.html#entry-points-for-plugins).
Expand Down

0 comments on commit e832fa9

Please sign in to comment.