No project description provided
Project description
SCF_FSM_PACKAGE
A resuable django application that can handle transition and workflow's in your project .
Authors
Installation
Install scf_fsm_package with pip
pip install finflo
In your django application , browse to installed_apps section in settings.py and add this ,
INSTALLED_APPS = [
'finflo',
'rest_framework'
]
if you want party you can customize by adding this finflo section in your settings.py NOTE : The FINFLO section is required
FINFLO = {
'FROM_PARTY' : 'django_app.model_name', # example
'FROM_PARTY' : 'accounts.party',
'TO_PARTY' : 'accounts.party'
}
or else simple mention None ,
FINFLO = {
'FROM_PARTY' : None,
'TO_PARTY' : None
}
now navigate to the middleware section and add the finflo middleware
MIDDLEWARE = [
'finflo.middleware.TransitionUserMiddleware',
]
Api urls
In your application's urls.py , you can include finflo's api urls for browsable api's
** make sure that you have installed DjangoRestFramework
Now add this peice of code in your urls.py
urlpatterns = [
path('', include('finflo.urls'))
]
Usage
-
import your transition function
from finflo.transitions import FinFlotransition
-
The transition function requires 4 positional arguments :
-
Arguments Data_Type type str action str stage int t_id (optional) int
Example 1 : generic
from finflo.transition import FinFlotransition
myhandler = FinFlotransition()
# example function
def index():
myhandler.transition(type = "PROGRAM",action = "submit" ,stage = 0)
return HttpResponse({"data"})
Example 2 : customizable
- Browse to /api/transition/
- send your type , action , stage , t_id(optional) in body
Tech Stack
1. Python
2. Django==3.2.5
3. Django-rest-framework
Additional API's
Api urls
Api URL's | METHOD | QUERY_PARAMS |
---|---|---|
localhost/model/ | GET | ?type=PROGRAM |
localhost/action/ | GET | NONE |
localhost/action/ | POST | NONE |
localhost/workflowitems/ | GET | NONE |
localhost/workevents/ | GET | NONE |
Support
For support, email support@venzo.com .
Future
- postgres support
- next_Avail_transitions
- customizable workflowitems and workflowevents
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.