Care Hello is a sample plugin, a plugin boilerplate to begin developing the plugin for care.
To develop the plug in local environment along with care, follow the steps below:
- Go to the care root directory and clone the plugin repository:
cd care
git clone [email protected]:ohcnetwork/care_hello.git- Add the plugin config in plug_config.py
...
hello_plugin = Plug(
name="hello", # name of the django app in the plugin
package_name="/app/care_hello", # this has to be /app/ + plugin folder name
version="", # keep it empty for local development
configs={}, # plugin configurations if any
)
plugs = [hello_plug]
...- Tweak the code in plugs/manager.py, install the plugin in editable mode
...
subprocess.check_call(
[sys.executable, "-m", "pip", "install", "-e", *packages] # add -e flag to install in editable mode
)
...- Rebuild the docker image and run the server
make re-build
make upImportant
Do not push these changes in a PR. These changes are only for local development.
To install care hello, you can add the plugin config in care/plug_config.py as follows:
...
hello_plug = Plug(
name="hello",
package_name="git+https://github.com/ohcnetwork/care_hello.git",
version="@master",
configs={},
)
plugs = [hello_plug]
...Extended Docs on Plug Installation
The following configurations variables are available for Care Hello:
HELLO_DUMMY_ENV: Dummy environment variable for testing
The plugin will try to find the API key from the config first and then from the environment variable.
This project is licensed under the terms of the MIT license.
This plugin was created with Cookiecutter using the ohcnetwork/care-plugin-cookiecutter.