Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radeklat authored Apr 23, 2024
1 parent 96e2216 commit 6fca89d
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,14 @@ Delfino is a simple wrapper around [Click commands](https://click.palletsproject

Delfino looks for any [`click.Command`](https://click.palletsprojects.com/en/8.0.x/api/#click.Command) sub-class in the following locations:

- `commands` folder in the root of the project (next to the `pyproject.toml` file). This location is useful for commands that don't need to be replicated in multiple locations/projects. To change the default location, use the `tool.delfino.local_command_folders` config option. It allows specifying more than one folder.
- `commands` folder in the root of the project (next to the `pyproject.toml` file) OR folders specified in the [config file](#configuration) under `tool.delfino.local_command_folders`. This location is useful for commands that don't need to be replicated in multiple locations/projects.
- python module import path (`<IMPORT_PATH>`) specified by `entry_point` of [a plugin](#minimal-plugin):
```toml
[tool.poetry.plugins] # Optional super table

[tool.poetry.plugins."delfino.plugin"]
"delfino-<PLUGIN_NAME>" = "<IMPORT_PATH>"
```
- Folder specified in the [config file](#configuration) under `tool.delfino.local_commands_directory`.

Any files starting with an underscore, except for `__init__.py`, will be ignored.

Expand Down

0 comments on commit 6fca89d

Please sign in to comment.