django-viewflow 2.1.0__tar.gz → 2.1.2__tar.gz

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.0
+Version: 2.1.2
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -25,5 +25,3 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: Django>=4.2
-Requires-Dist: django-filter>=2.3.0

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/README.md

@@ -143,6 +143,8 @@ Make and run migrations to create the necessary database tables, then start your
 server and access the workflow through the pre-built frontend. You should be
 able to create and track pizza orders with the workflow.
 
+Go to the https://docs.viewflow.io/workflow/writing.html for the next steps
+
 ## Documentation
 
 Viewflow's documentation for the latest version is available at
@@ -183,6 +185,20 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
+### 2.1.2 2024-06-24
+
+- Allow cancelling Celery tasks from the ERROR state.
+- Hotfix: Fix broken Join when no other nodes are created by Split.
+- Allow using this references to flow static methods as Celery tasks.
+- Allow cancelling Celery jobs from the ERROR status.
+- Add missing permission check before adding a new item to the list.
+- Allow Admin() viewset to be used as a sub-item in an Application viewset.
+
+### 2.1.1 2024-06-06
+
+- Hotfix broken task creation
+
+
 ### 2.1.0 2024-06-16
 
 - Allow to assign additional custom data to viewflow.fsm transitions

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/django_viewflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.0
+Version: 2.1.2
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -25,5 +25,3 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: Django>=4.2
-Requires-Dist: django-filter>=2.3.0

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/setup.py

@@ -4,7 +4,7 @@ README = open("README.md", "r", encoding="utf-8").read()
 
 setuptools.setup(
     name="django-viewflow",
-    version="2.1.0",
+    version="2.1.2",
     author_email="kmmbvnr@gmail.com",
     author="Mikhail Podgurskiy",
     description="Reusable library to build business applications fast",

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/contrib/admin/__init__.py

@@ -9,20 +9,22 @@ from django.contrib import admin
 from django.utils.translation import gettext_lazy as _
 
 from viewflow import Icon
-from viewflow.urls import Application
+from viewflow.urls import Application, AppMenuMixin
 
 
-class Admin(Application):
+class Admin(AppMenuMixin, Application):
     """
     Django administration Viewset adapter::
 
-        from material.contrib.admin import Admin
+        from django.contrib import admin
+        from viewflow.contrib.admin import Admin
 
-        site = Site(apps=[
+        site = Site(viewsets=[
             Admin()
         ])
 
         urls = [
+            path("admin/", admin.site.urls),
             path('', site.urls)
         ]
 

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/contrib/auth.py

@@ -132,23 +132,29 @@ def get_user_avatar_url(user):
 
 class AuthViewset(Viewset):
     """
-    Class-based url configuration for the `django.contrib.auth`.
-
-    urlpatterns = [
-        path('accounts/', AuthViewset(
-            allow_password_change=False,
-            login_view=views.LoginView.as_view(
-                authentication_form=MyAuthForm
-            ),
-        ).urls),
-    ]
+    Class-based URL configuration for `django.contrib.auth`.
+
+    This viewset provides URL patterns for user authentication, including login,
+    logout, and password management views.
+
+    .. code-block:: python
+
+        urlpatterns = [
+            path('accounts/', AuthViewset(
+                allow_password_change=False,
+                login_view=views.LoginView.as_view(
+                    authentication_form=MyAuthForm
+                ),
+            ).urls),
+        ]
     """
 
     def __init__(self, *, allow_password_change=True, with_profile_view=True, **kwargs):
         """
-        Initialize the viewset.
+        Initialize the viewset with options for password change and profile view.
 
-        :param allow_password_change=True: enable password change/reset views
+        :param allow_password_change: Enable or disable password change/reset views. Defaults to True.
+        :param with_profile_view: Enable or disable profile view. Defaults to True.
         """
         super().__init__(**kwargs)
         self.allow_password_change = allow_password_change
@@ -160,16 +166,32 @@ class AuthViewset(Viewset):
     login_view_class = views.LoginView
 
     def get_login_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the login view.
+
+        :param kwargs: Additional keyword arguments for the login view.
+        :return: Dictionary of keyword arguments.
+        """
         result = {"form_class": AuthenticationForm}
         result.update(kwargs)
         return result
 
     @viewprop
     def login_view(self):
+        """
+        Property to get the configured login view.
+
+        :return: Configured login view instance.
+        """
         return self.login_view_class.as_view(**self.get_login_view_kwargs())
 
     @property
     def login_path(self):
+        """
+        Property to get the URL pattern for the login view.
+
+        :return: URL pattern for the login view.
+        """
         return path("login/", self.login_view, name="login")
 
     """
@@ -178,14 +200,30 @@ class AuthViewset(Viewset):
     logout_view_class = views.LogoutView
 
     def get_logout_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the logout view.
+
+        :param kwargs: Additional keyword arguments for the logout view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def logout_view(self):
+        """
+        Property to get the configured logout view.
+
+        :return: Configured logout view class.
+        """
         return self.logout_view_class.as_view(**self.get_logout_view_kwargs())
 
     @property
     def logout_path(self):
+        """
+        Property to get the URL pattern for the logout view.
+
+        :return: URL pattern for the logout view.
+        """
         return path("logout/", self.logout_view, name="logout")
 
     """
@@ -194,14 +232,30 @@ class AuthViewset(Viewset):
     pass_change_view_class = views.PasswordChangeView
 
     def get_pass_change_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password change view.
+
+        :param kwargs: Additional keyword arguments for the password change view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_change_view(self):
+        """
+        Property to get the configured password change view.
+
+        :return: Configured password change view class.
+        """
         return self.pass_change_view_class.as_view(**self.get_pass_change_view_kwargs())
 
     @property
     def pass_change_path(self):
+        """
+        Property to get the URL pattern for the password change view.
+
+        :return: URL pattern for the password change view.
+        """
         if self.allow_password_change:
             return path(
                 "password_change/", self.pass_change_view, name="password_change"
@@ -213,16 +267,32 @@ class AuthViewset(Viewset):
     pass_change_done_view_class = views.PasswordChangeDoneView
 
     def get_pass_change_done_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password change done view.
+
+        :param kwargs: Additional keyword arguments for the password change done view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_change_done_view(self):
+        """
+        Property to get the configured password change done view.
+
+        :return: Configured password change done view class.
+        """
         return self.pass_change_done_view_class.as_view(
             **self.get_pass_change_done_view_kwargs()
         )
 
     @property
     def pass_change_done_path(self):
+        """
+        Property to get the URL pattern for the password change done view.
+
+        :return: URL pattern for the password change done view.
+        """
         if self.allow_password_change:
             return path(
                 "password_change/done/",
@@ -236,14 +306,30 @@ class AuthViewset(Viewset):
     pass_reset_view_class = views.PasswordResetView
 
     def get_pass_reset_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password reset request view.
+
+        :param kwargs: Additional keyword arguments for the password reset request view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_reset_view(self):
+        """
+        Property to get the configured password reset request view.
+
+        :return: Configured password reset request view class.
+        """
         return self.pass_reset_view_class.as_view(**self.get_pass_reset_view_kwargs())
 
     @property
     def pass_reset_path(self):
+        """
+        Property to get the URL pattern for the password reset request view.
+
+        :return: URL pattern for the password reset request view.
+        """
         if self.allow_password_change:
             return path("password_reset/", self.pass_reset_view, name="password_reset")
 
@@ -253,16 +339,32 @@ class AuthViewset(Viewset):
     pass_reset_done_view_class = views.PasswordResetDoneView
 
     def get_pass_reset_done_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password reset request done view.
+
+        :param kwargs: Additional keyword arguments for the password reset request done view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_reset_done_view(self):
+        """
+        Property to get the configured password reset request done view.
+
+        :return: Configured password reset request done view class.
+        """
         return self.pass_reset_done_view_class.as_view(
             **self.get_pass_reset_done_view_kwargs()
         )
 
     @property
     def pass_reset_done_path(self):
+        """
+        Property to get the URL pattern for the password reset request done view.
+
+        :return: URL pattern for the password reset request done view.
+        """
         if self.allow_password_change:
             return path(
                 "password_reset/done/",
@@ -276,16 +378,32 @@ class AuthViewset(Viewset):
     pass_reset_confirm_view_class = views.PasswordResetConfirmView
 
     def get_pass_reset_confirm_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password reset confirm view.
+
+        :param kwargs: Additional keyword arguments for the password reset confirm view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_reset_confirm_view(self):
+        """
+        Property to get the configured password reset confirm view.
+
+        :return: Configured password reset confirm view class.
+        """
         return self.pass_reset_confirm_view_class.as_view(
             **self.get_pass_reset_confirm_view_kwargs()
         )
 
     @property
     def pass_reset_confirm_path(self):
+        """
+        Property to get the URL pattern for the password reset confirm view.
+
+        :return: URL pattern for the password reset confirm view.
+        """
         if self.allow_password_change:
             return path(
                 "reset/<uidb64>/<token>/",
@@ -299,16 +417,32 @@ class AuthViewset(Viewset):
     pass_reset_complete_view_class = views.PasswordResetCompleteView
 
     def get_pass_reset_complete_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the password reset complete view.
+
+        :param kwargs: Additional keyword arguments for the password reset complete view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def pass_reset_complete_view(self):
+        """
+        Property to get the configured password reset complete view.
+
+        :return: Configured password reset complete view class.
+        """
         return self.pass_reset_complete_view_class.as_view(
             **self.get_pass_reset_complete_view_kwargs()
         )
 
     @property
     def pass_reset_complete_path(self):
+        """
+        Property to get the URL pattern for the password reset complete view.
+
+        :return: URL pattern for the password reset complete view.
+        """
         if self.allow_password_change:
             return path(
                 "reset/done/",
@@ -322,14 +456,30 @@ class AuthViewset(Viewset):
     profile_view_class = ProfileView
 
     def get_profile_view_kwargs(self, **kwargs):
+        """
+        Get keyword arguments for the profile view.
+
+        :param kwargs: Additional keyword arguments for the profile view.
+        :return: Dictionary of keyword arguments.
+        """
         return kwargs
 
     @viewprop
     def profile_view(self):
+        """
+        Property to get the configured profile view.
+
+        :return: Configured profile view class.
+        """
         return self.profile_view_class.as_view(**self.get_profile_view_kwargs())
 
     @property
     def profile_path(self):
+        """
+        Property to get the URL pattern for the profile view.
+
+        :return: URL pattern for the profile view.
+        """
         if self.with_profile_view:
             return path("profile/", self.profile_view, name="profile")
 

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/urls/model.py

@@ -6,6 +6,7 @@
 # which is part of this source code package.
 
 from django.urls import path
+from django.utils.translation import gettext_lazy as _
 
 from viewflow.urls import AppMenuMixin, Viewset, ViewsetMeta
 from viewflow.utils import DEFAULT, Icon, first_not_default, has_object_perm, viewprop
@@ -138,12 +139,14 @@ class CreateViewMixin(metaclass=ViewsetMeta):
         return self.filter_kwargs(self.create_view_class, **view_kwargs)
 
     def get_list_page_actions(self, request, *actions):
-        add_action = Action(
-            name="Add new",
-            url=self.reverse("add"),
-            icon=Icon("add_circle", class_="material-icons mdc-list-item__graphic"),
-        )
-        return super().get_list_page_actions(request, *(add_action, *actions))
+        if self.has_add_permission(request.user):
+            add_action = Action(
+                name=_("Add new"),
+                url=self.reverse("add"),
+                icon=Icon("add_circle", class_="material-icons mdc-list-item__graphic"),
+            )
+            actions = (add_action, *actions)
+        return super().get_list_page_actions(request, *actions)
 
     @viewprop
     def create_view_kwargs(self):

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/flow/nodes.py

@@ -316,8 +316,37 @@ class Split(
     nodes.Split,
 ):
     """
-    Parallel split gateway.
+    Represents a parallel split gateway in a workflow, allowing branching into multiple parallel paths.
 
+    Methods:
+        - `Next(node, case=None, data_source=None)`: Defines the subsequent node in the workflow.
+
+          * `node`: The next node to execute.
+          * `case` (optional): A callable that takes an activation and returns `True` if the node should be activated.
+          * `data_source` (optional): A callable that takes an activation and returns a list of data items, creating an instance of the node for each item, with `task.data` set to the item.
+
+        - `Always(node)`: A shortcut to define a subsequent node that is always executed.
+
+    Example:
+
+    .. code-block:: python
+
+        flow.Split()
+            .Next(
+                this.approve,
+                case=act.process.approved,
+                data_source=lambda activation: [{"sample": "test task 1"}, {"sample": "test task 2"}],
+            )
+            .Always(this.required)
+
+
+    In this example:
+        - The `approve` node is executed multiple times based on the `data_source` list.
+        - The `required` node is always executed unconditionally in parallel.
+
+    Notes:
+        - If `case` is not provided, the node is always activated.
+        - If `data_source` is not provided, the node is created only once.
     """
 
     index_view_class = views.IndexTaskView
@@ -330,6 +359,30 @@ class SplitFirst(
     mixins.NodeDetailMixin,
     nodes.SplitFirst,
 ):
+    """
+    Parallel split, as soon as the first task is completed, the remaining tasks
+    are cancelled.
+
+    The `SplitFirst` class is useful in workflows where you want to initiate
+    multiple parallel tasks but only require the first task to complete,
+    cancelling the rest once the first task finishes.
+
+    Example:
+
+    .. code-block:: python
+
+        class MyFlow(flow.Flow):
+            split_first = SplitFirst().Next(this.task_a).Next(this.task_b)
+
+            task_a = flow.View(views.UserView).Next(this.join)
+
+            task_b = celery.Timer(delay=timedelata(minutes=10)).Next(this.join)
+
+            join = flow.Join()
+
+
+    """
+
     index_view_class = views.IndexTaskView
     detail_view_class = views.DetailTaskView
 

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/nodes/job.py

@@ -14,7 +14,7 @@ from . import mixins
 
 class AbstractJobActivation(mixins.NextNodeActivationMixin, Activation):
     @classmethod
-    def create(cls, flow_task, prev_activation, token):
+    def create(cls, flow_task, prev_activation, token, data=None):
         """Instantiate and persist new flow task."""
         flow_class = flow_task.flow_class
         task = flow_class.task_class(
@@ -22,6 +22,7 @@ class AbstractJobActivation(mixins.NextNodeActivationMixin, Activation):
             flow_task=flow_task,
             token=token,
             external_task_id=str(uuid.uuid4()),
+            data=data if data is not None else {},
         )
         task.save()
         task.previous.add(prev_activation.task)

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/nodes/join.py

@@ -15,7 +15,7 @@ class JoinActivation(mixins.NextNodeActivationMixin, Activation):
         super().__init__(*args, **kwargs)
 
     @classmethod
-    def create(cls, flow_task, prev_activation, token):
+    def create(cls, flow_task, prev_activation, token, data=None):
         """
         Join and, if all incoming paths are completed, continue execution.
 
@@ -43,7 +43,10 @@ class JoinActivation(mixins.NextNodeActivationMixin, Activation):
                 token = token.get_base_split_token()
 
             task = flow_class.task_class.objects.create(
-                process=prev_activation.process, flow_task=flow_task, token=token
+                process=prev_activation.process,
+                flow_task=flow_task,
+                token=token,
+                data=data if data is not None else {},
             )
 
         task.previous.add(prev_activation.task)

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/nodes/split.py

@@ -47,7 +47,7 @@ class SplitActivation(Activation):
 
         next_tasks = [
             (task, data) for task, data in self.next_tasks if not isinstance(task, Join)
-        ] + [(task, None) for task in self.next_tasks if isinstance(task, Join)]
+        ] + [(task, data) for task, data in self.next_tasks if isinstance(task, Join)]
 
         for n, (next_task, data) in enumerate(next_tasks, 1):
             yield next_task._create(

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/nodes/start.py

@@ -13,12 +13,15 @@ class StartActivation(mixins.NextNodeActivationMixin, Activation):
     """Task activation that creates new process instance."""
 
     @classmethod
-    def create(cls, flow_task, prev_activation, token):
+    def create(cls, flow_task, prev_activation, token, data=None):
         flow_class = flow_task.flow_class
 
         process = flow_class.process_class(flow_class=flow_class)
         task = flow_class.task_class(
-            flow_task=flow_task, process=process, started=now()
+            flow_task=flow_task,
+            process=process,
+            started=now(),
+            data=data if data is not None else {},
         )
 
         return cls(task)

{django-viewflow-2.1.0 → django-viewflow-2.1.2}/viewflow/workflow/nodes/view.py

@@ -13,11 +13,14 @@ class ViewActivation(mixins.NextNodeActivationMixin, Activation):
     """View node activation."""
 
     @classmethod
-    def create(cls, flow_task, prev_activation, token):
+    def create(cls, flow_task, prev_activation, token, data=None):
         """Instantiate and persist new flow task."""
         flow_class = flow_task.flow_class
         task = flow_class.task_class(
-            process=prev_activation.process, flow_task=flow_task, token=token
+            process=prev_activation.process,
+            flow_task=flow_task,
+            token=token,
+            data=data if data is not None else {},
         )
 
         activation = cls(task)