mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-28 11:36:44 +00:00
9b5e828b87
* Hide protected setting in settings view * Implement custom serializer for setting value - Return '***' if the setting is protected * Implement to_internal_value * Stringify * Add protected setting to sample plugin * Unit tests for plugin settings API * Update unit test (cherry picked from commit 01f2aa5f746a36706e9a5e588c4242b7bf1996d5) Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
86 lines
2.6 KiB
Python
86 lines
2.6 KiB
Python
"""Sample implementations for IntegrationPlugin."""
|
|
|
|
from django.http import HttpResponse
|
|
from django.urls import include, re_path
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plugin import InvenTreePlugin
|
|
from plugin.mixins import AppMixin, NavigationMixin, SettingsMixin, UrlsMixin
|
|
|
|
|
|
class SampleIntegrationPlugin(AppMixin, SettingsMixin, UrlsMixin, NavigationMixin, InvenTreePlugin):
|
|
"""A full plugin example."""
|
|
|
|
NAME = "SampleIntegrationPlugin"
|
|
SLUG = "sample"
|
|
TITLE = "Sample Plugin"
|
|
|
|
NAVIGATION_TAB_NAME = "Sample Nav"
|
|
NAVIGATION_TAB_ICON = 'fas fa-plus'
|
|
|
|
def view_test(self, request):
|
|
"""Very basic view."""
|
|
return HttpResponse(f'Hi there {request.user.username} this works')
|
|
|
|
def setup_urls(self):
|
|
"""Urls that are exposed by this plugin."""
|
|
he_urls = [
|
|
re_path(r'^he/', self.view_test, name='he'),
|
|
re_path(r'^ha/', self.view_test, name='ha'),
|
|
]
|
|
|
|
return [
|
|
re_path(r'^hi/', self.view_test, name='hi'),
|
|
re_path(r'^ho/', include(he_urls), name='ho'),
|
|
]
|
|
|
|
SETTINGS = {
|
|
'PO_FUNCTION_ENABLE': {
|
|
'name': _('Enable PO'),
|
|
'description': _('Enable PO functionality in InvenTree interface'),
|
|
'default': True,
|
|
'validator': bool,
|
|
},
|
|
'API_KEY': {
|
|
'name': _('API Key'),
|
|
'description': _('Key required for accessing external API'),
|
|
},
|
|
'NUMERICAL_SETTING': {
|
|
'name': _('Numerical'),
|
|
'description': _('A numerical setting'),
|
|
'validator': int,
|
|
'default': 123,
|
|
},
|
|
'CHOICE_SETTING': {
|
|
'name': _("Choice Setting"),
|
|
'description': _('A setting with multiple choices'),
|
|
'choices': [
|
|
('A', 'Anaconda'),
|
|
('B', 'Bat'),
|
|
('C', 'Cat'),
|
|
('D', 'Dog'),
|
|
],
|
|
'default': 'A',
|
|
},
|
|
'SELECT_COMPANY': {
|
|
'name': 'Company',
|
|
'description': 'Select a company object from the database',
|
|
'model': 'company.company',
|
|
},
|
|
'SELECT_PART': {
|
|
'name': 'Part',
|
|
'description': 'Select a part object from the database',
|
|
'model': 'part.part',
|
|
},
|
|
'PROTECTED_SETTING': {
|
|
'name': 'Protected Setting',
|
|
'description': 'A protected setting, hidden from the UI',
|
|
'default': 'ABC-123',
|
|
'protected': True,
|
|
}
|
|
}
|
|
|
|
NAVIGATION = [
|
|
{'name': 'SampleIntegration', 'link': 'plugin:sample:hi'},
|
|
]
|