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.

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

Initialise DLite search paths from entry points #990

Merged
merged 7 commits into from
Oct 30, 2024
Merged

Conversation

jesper-friis
Copy link
Collaborator

@jesper-friis jesper-friis commented Oct 27, 2024

Description

Allow developers of packages that uses dlite to define entry_points with paths to datamodels and plugins.

Also documented DLite search paths and how to extend them.

Type of change

  • Bug fix & code cleanup
  • New feature
  • Documentation update
  • Test update

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

  • Is the change limited to one issue?
  • Does this PR close the issue?
  • Is the code easy to read and understand?
  • Do all new feature have an accompanying new test?
  • Has the documentation been updated as necessary?

Comment on lines +38 to +39
All the path variables, except for `DLITE_STORAGES`, uses (`:`) colon as path separator.
However, since colon may appears in URLs, `DLITE_STORAGES` uses instead the pipe symbol (`|`) as path separator.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not have the same separator in all? Also, one could envison plugins being available on the internet somewhere (for the future)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I think this would be a very good thing to add as an issue. We could then deprecate the use of colon over some releases and standardise on "|"


```

See [Extending DLite] for more information.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does this point to?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected. It now points to search_paths.html

Copy link
Collaborator

@francescalb francescalb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approvved, but please write the issue in the issue-tracker.

@jesper-friis jesper-friis merged commit 5fc9c11 into master Oct 30, 2024
14 checks passed
@jesper-friis jesper-friis deleted the entry-points branch October 30, 2024 16:07
@jesper-friis jesper-friis linked an issue Oct 30, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it possible to use entry points to register DLite plugins
2 participants