Skip to main content

No project description provided

Project description

SCF_FSM_PACKAGE

A resuable python django package that can handle transition and workflow's in your django application .

Description

  • The finflo package is designed to take over all the complexity in FSM building for a workflow scenario
  • Your transition's are made easy with finflo
  • customizable Actions and states with on_flow interchangable

Authors

Prerequisite

  • python
  • Django
  • Django-rest-framework

1. Installation

1.1 Initial setup

  • Install finflo using pip
pip install finflo
  • In your django application , browse to installed_apps section in settings.py and add this ,
INSTALLED_APPS = [
    'finflo',
    'rest_framework'
]
  • Add this in your settings.py
FINFLO = {
    'WORK_MODEL' : ['MyApp.Model','MyApp2.Model2']
}
  • Navigate to the middleware section in your settings.py and add the finflo middleware
MIDDLEWARE = [
    'finflo.middleware.TransitionUserMiddleware',
]
  • Now add this peice of code in your urls.py
urlpatterns = [
    path('', include('finflo.urls'))
]

1.2 Migrations

  • once all the steps done from the above section 1.1 .
  • now we can apply the migrations for the database using ,
- python manage.py makemigrations
- python manage.py migrate 

1.3 Re-migrate

  • scenario 1 : if any new values is added to the WORK_MODEL
  • example for scenario 1 :
# see 1.1 

FINFLO = {
    'WORK_MODEL' : ['MyApp.Model','MyApp2.Model2','MyApp3.Model3']
}

  • you can remigrate the database without droping it using the below command .
- python manage.py migrate finflo 0002

Usage

  1. Once your setup is completed , whenever the objects in WORK_MODEL is created , the finflo automatically creates :

    • Transition manager
    • workflowitems
    • workevents
  2. The transition for each model can be carried out with :

    • t_id (transition_id)
    • type (model_type)
    • action
    • example
    • Screenshot
  3. Some important information for transition are as follows :

    Arguments Data_Type
    type str
    action str
    t_id int
    source (optional) str
    interim (optional) str
    target (optional) str
    from_party (optional) str
    to_party (optional) str

Additional API's

Api urls

Api URL's METHOD QUERY_PARAMS
localhost/model/ GET ?type=PROGRAM & t_id = 1
localhost/action/ GET NONE
localhost/action/ POST NONE
localhost/workflowitems/ GET NONE
localhost/workevents/ GET NONE

Support

For support, email support@venzo.com .

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.

Source Distribution

finflo-1.9.7.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

finflo-1.9.7-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file finflo-1.9.7.tar.gz.

File metadata

  • Download URL: finflo-1.9.7.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for finflo-1.9.7.tar.gz
Algorithm Hash digest
SHA256 3b5ac081f85e309f20474581854775a2512c271e4ed8cde45b805c08557feac2
MD5 6c37cbdd38e71573557f638c85d6d92a
BLAKE2b-256 c12b72bbf9302516da96699605fe093671bc6141597cf9c58974df5117970f51

See more details on using hashes here.

File details

Details for the file finflo-1.9.7-py3-none-any.whl.

File metadata

  • Download URL: finflo-1.9.7-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for finflo-1.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ff13d5b9e932a7a29a071af98f0d06235ed43c7a8a69c4a21bddebf172fe36d8
MD5 f4893cb2e7d57108aa96c51e5e0d0cff
BLAKE2b-256 5f1b0e80e172c519ef24fab3747828d6b6a97ec53450d02f09687b680b2ec0fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page