This documentation covers HookMan usage & API.
For information about HookMan, read the section above. For public changelog and how the project is maintained, please check the GitHub page
What is HookMan?¶
HookMan is a python package that provides a plugin management system to applications,
specially those who are written (in totally or partially) in C++.
It enables external contributors to implement plugins which act as extensions written in C/C++ that interact with the application through well-defined hooks.
It was conceived to facilitate the application development, allowing hooks to be exposed in a clear way and allowing plugins to be developed without access to classes or data from the application.
HookMan your application can have access to the hooks implemented on plugins as simple as the example below.
# Initializing a class hm = HookMan(specs=acme_specs, plugin_dirs=['path1','path2']) hook_caller = hm.get_hook_caller() # Getting access to the hook implementation friction_factor = hook_caller.friction_factor() env_temperature = hook_caller.env_temperature() # Checking if the hook was implemented assert friction_factor is not None assert env_temperature is None # Executing the hook, wherever it is implemented either in plugin A or B. ff_result = friction_factor(1, 2.5) env_tmp_result = env_temperature(35.5, 45.5)
How does it work?¶
In order to use
HookMan in your application, it is necessary to inform which
are available to be implemented through a configuration object.
With this configuration defined, users can create plugins that implement available
Hooks extending the behavior of your application.
All plugins informed to your application will be validated by HookMan (to check which hooks are implemented),
and an object holding a reference to the
Hooks will be passed to the application.
HookMan project uses the library pybind11 to interact between Python and C/C++,
allowing a straightforward usage for who is calling the function (either in Python or in C++).
Defining some terminologies:
Application⇨ The program that offers the extensions.
Hook⇨ An extension of the Application.
Plugin⇨ The program that implements the
User⇨ The person who installed the application.
Free software: MIT license
To get quick and running with
HookMan you can read the Quick Start section.
After reading the quick start section, check out these additional resources to help better understand the project flow:
In order to integrate the
HookMan project in your application, by listing available plugins and checking conflicts read the section:
Dig deeper into specific topics: