Skip to content

Commit

Permalink
fix(hyfi): add plugin initialization details
Browse files Browse the repository at this point in the history
  • Loading branch information
entelecheia committed Jul 24, 2023
1 parent f6d2ecf commit dfc238a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/hyfi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,15 @@ def initialize_global_hyfi(
Initializes the global HyFI instance.
This function should be called before any other HyFI function.
A plugin is a python module which contains a configuration module.
Be careful!
It does not check if the plugin is importable.
Args:
package_name: Name of the package. e.g. `hyfi`
version: Version of the package. e.g. `0.1.0`
plugins: A list of plugins to load. e.g. `["hyfi.conf"]`
"""
global_hyfi.initialize(package_name=package_name, version=version)

0 comments on commit dfc238a

Please sign in to comment.