--- title: Plugins keywords: fastai sidebar: home_sidebar nb_path: "nbs/plugin.pluginbase.ipynb" ---
PluginBase is the plugin class that the simplest plugin inherits.
Inheriting class should implement:
The memri pod uses a plugin system to add features to the backend memri backend. Plugins can import your data (importers), change your data (indexers), or call other serivces. Users can define their own plugins to add new behaviour to their memri app. Let's use the following plugin as an example of how we can start plugins.
class MySimplePlugin(PluginBase):
""""""
def __init__(self, **kwargs):
super().__init__(**kwargs)
def run(self):
print("running")
items = self.client.search({'type': 'MyItem'})
for item in items:
if item.age > 65:
item.name = f"Sr. {item.name}"
if item.age <= 18:
item.name = f"Jr. {item.name}"
def add_to_schema(self):
self.client.add_to_schema(MyItem("my name", 10))
class ExampleOAuthAuthenticator(OAuthAuthenticator):
def get_oauth_url(self):
return "https://example.com/oauth"
def get_tokens_from_code(self, code):
return {
'access_token': 'dummy_access_token_with_' + code,
'refresh_token': 'dummy_refresh_token'
}
def refresh_tokens(self, refreshToken):
return {
'access_token': 'refreshed_dummy_access_token',
'refresh_token': 'refreshed_dummy_refresh_token'
}
def get_api_instance(self):
return MyAPIClient(self.pluginRun.account[0].secret)
class ExamplePasswordAuthenticator(PasswordAuthenticator):
SERVICE_URL = "https://example.com/login"
def get_token(self, username, password):
result = requests.post(self.SERVICE_URL, {'username': username, 'password': password})
if result.status_code == 200:
try:
res = result.json()
return res['session_token']
except:
pass
class MyAPIClient:
def __init__(self, accessToken):
self.access_token = accessToken
def get_data(self):
return [{'name': 'name_1', 'age': 21}, {'name': 'name_2', 'age': 22}]
class MyItem(Item):
properties = Item.properties + ["name", "age"]
edges = Item.edges
def __init__(self, name=None, age=None, **kwargs):
super().__init__(**kwargs)
self.name = name
self.age = age
class MyOAuthPlugin(PluginBase):
""""""
def __init__(self, **kwargs):
super().__init__(**kwargs)
def run(self):
print("running")
self.login()
items = self.api.get_data()
for item in items:
self.client.create(MyItem(name=item['name'], age=item['age']))
def login(self):
auth = ExampleOAuthAuthenticator(self.client, self.pluginRun)
# auth.isTest = True # for testing
auth.authenticate()
self.api = MyAPIClient(self.pluginRun.account[0].secret)
def add_to_schema(self):
self.client.add_to_schema(MyItem("my name", 10))
class MyPasswordPlugin(PluginBase):
""""""
def __init__(self, **kwargs):
super().__init__(**kwargs)
def run(self):
print("running")
self.login()
items = self.api.get_data()
for item in items:
self.client.create(MyItem(name=item['name'], age=item['age']))
def login(self):
auth = PasswordAuthenticator(self.client, self.pluginRun)
auth.isTest = True
token = auth.authenticate()
self.api = MyAPIClient(token)
def add_to_schema(self):
self.client.add_to_schema(MyItem("my name", 10))
Memri plugins need to define at least 2 methods: .run()
and .add_to_schema()
. .run()
defines the logic of the plugin. .add_to_schema()
defines the schema for the plugin in the pod. Note that currently, add_to_schema
requires all item to have all properties defined that are used in the plugin. In the future, we might replace add_to_schema, to be done automatically, based on a declarative schema defined in the plugin.
Plugins can be started using the pymemri run_plugin
or simulate_run_plugin_from_frontend
CLI. With run_plugin
the plugin is invoked directly by spawning a new python process, while simulate_run_plugin_from_frontend
requests the pod to spawn a new process, docker container, or kubernetes container, which in calls run_plugin
(for more info see simulate_run_plugin_from_frontend
. When using run_plugin
, you can either pass your run arguments as parameters, or set them as environment variables. If both are set, the CLI will use the passed arguments.
To start a plugin on your local machine, you can use the CLI. This will create a client for you, and run the code defined in <myplugin>.run()
run_plugin(config_file="../example_config.json")
{% include note.html content='The data that is created here should be in the pod in order for this to work' %}
In production, we start plugins by making an API call to the pod, which in turn creates an environment for the plugin and starts it using docker containers, kubernetes containers or a shell script. We can start this process using the simulate_run_plugin_from_frontend
CLI. Note that when using docker, provided container name should be "installed" within the Pod environemnt (e.g. docker build -t pymemri .
for this repo) in order to start it.
client = PodClient()
!simulate_run_plugin_from_frontend --config_file="../example_config.json"