未提供项目说明
shuup-onboarding的Python项目详细描述
休普入职培训
在shup中添加动态面板,以便于入职(特别是在管理中)。在
安装和配置
安装此软件包
运行pip install shuup_onboarding
并将shuup_onboarding
添加到INSTALLED_APPS
。在
实现您的入职步骤并添加入职中间件
通过实现OnboardingStep
类编写一些入职步骤(任意数量),遵循一个简单的示例:
classMyInfoStep(OnboardingStep):identifier="my_step_id"title="My Step Title"description="Some description of the step"template_name="my_app/step_template.jinja"defcan_skip(self):returnFalsedefis_done(self):returnself.context.storage.get("my_info")defis_visible(self):returnTruedefget_form(self,**kwargs)->forms.Form:returnMyStepForm(**kwargs)defsave(self,form):self.context.storage["my_info"]=form.cleaned_data["info"]defundo(self):self.context.storage.pop("my_info",None)
然后,您需要创建一个唯一的入职流程标识符。为了举例,让我们使用my_onboarding_process
作为我们的入职标识符。在
现在您需要重写基本中间件类BaseAdminOnboardingMiddleware
,并配置您的process id属性:
要使入职流程加载您的步骤,您必须使用特殊的provides密钥:
onboarding_process:[YOUR_ONBOARDING_PROCESS-ID]
最后,将您的入职步骤添加到“提供”中:
classAppConfig(shuup.apps.AppConfig):provides={"onboarding_process:my_onboarding_process":["my_app.onboarding_steps.MyInfoStep","my_app.onboarding_steps.FinalStep",]
完成了。在
您可以在Shuup Onboarding Example找到完整的工作示例。在
许可证
开放式软件许可证3.0版
版权所有
版权所有(c)2020 Christian Hess
- 项目
标签: