django-viewflow 2.1.1__tar.gz → 2.2.3__tar.gz

{django-viewflow-2.1.1 → django-viewflow-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.1
+Version: 2.2.3
 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.1 → django-viewflow-2.2.3}/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,10 +185,41 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
-### 2.1.0 2024-06-16
+### 2.2.3 2024-07-09
+
+- Fixed issue with Split/Join operations when an immediate split to join
+  connection occurs.
+- Improved redirect functionality for "Execute and Continue." Now redirects to
+  the process details if the process has finished.
+- Enabled the Undo action for End() nodes.
+
+
+### 2.2.2 2024-07-05
+
+- Introduced new parameters for .If().Then(.., task_data=, task_seed) and
+  .Else(...)
+- Include {{ form.media }} into default workflow/task.html template
+
+
+### 2.2.1 2024-07-03
+
+- Introduced a new parameter for .Next(..., task_seed=) that allows the
+  instantiation of new tasks with additional initialized .seed generic foreign key
+- Introduced a new parameter for .Split(..., task_seed_source=) same as task_data_source,
+  prodices outgoing tasks with initializaed .seed value
+- Introduced a new parameter for flow.Subprocess(process_data=, process_seed=,
+  task_data=, task_seed=) allows to provide data nad seed for newly created
+  process and/or start task
+
+### 2.2.0 2024-06-28
 
-- Allow to assign additional custom data to viewflow.fsm transitions
-- Added `data_source` parameter to `Split.Next()` method, allowing dynamic creation of multiple node instances based on a list of data items.
+- Introduced a new parameter for .Next(..., task_data=) that allows the
+  instantiation of new tasks with additional initialized .data, enabling data to
+  be passed from task to task.
+- Added process.seed and task.seed generic foreign keys to the default workflow
+  models. Along with process.artifact and task.artifact, these additions enable
+  tracking of business process results from start to finish.
+- Renamed Split.Next(data_source=) to task_data_source=.
 
 
 [build]: https://img.shields.io/github/actions/workflow/status/viewflow/viewflow/django.yml?branch=main

{django-viewflow-2.1.1 → django-viewflow-2.2.3}/django_viewflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.1
+Version: 2.2.3
 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.1 → django-viewflow-2.2.3}/django_viewflow.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 LICENSE
-LICENSE.django
 LICENSE_EXCEPTION
 MANIFEST.in
 README.md
@@ -306,6 +305,7 @@ viewflow/workflow/migrations/0009_merge.py
 viewflow/workflow/migrations/0010_viewflow20.py
 viewflow/workflow/migrations/0011_alter_task_created_and_more.py
 viewflow/workflow/migrations/0012_alter_process_data_alter_task_data.py
+viewflow/workflow/migrations/0013_process_seed_content_type_process_seed_object_id_and_more.py
 viewflow/workflow/migrations/__init__.py
 viewflow/workflow/nodes/__init__.py
 viewflow/workflow/nodes/end.py
@@ -318,6 +318,5 @@ viewflow/workflow/nodes/mixins.py
 viewflow/workflow/nodes/obsolete.py
 viewflow/workflow/nodes/split.py
 viewflow/workflow/nodes/start.py
-viewflow/workflow/nodes/subprocess.py
 viewflow/workflow/nodes/switch.py
 viewflow/workflow/nodes/view.py

{django-viewflow-2.1.1 → django-viewflow-2.2.3}/setup.py

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

{django-viewflow-2.1.1 → django-viewflow-2.2.3}/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.1 → django-viewflow-2.2.3}/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.1 → django-viewflow-2.2.3}/viewflow/templates/viewflow/workflow/task.html

@@ -1,6 +1,10 @@
 {% extends request.resolver_match.app.base_template_name|default:'viewflow/workflow/base_page.html' %}
 {% load i18n viewflow workflow %}
 
+{% block extrahead %}
+  {{ block.super }}
+  {{ form.media }}
+{% endblock %}
 
 {% block content %}{% with process=request.activation.process task=request.activation.task %}
   <div class="mdc-layout-grid vf-page__grid">

django-viewflow-2.2.3/viewflow/this_object.py

@@ -0,0 +1,119 @@
+"""Forward-reference for class-body declarations"""
+
+# Copyright (c) 2017-2020, Mikhail Podgurskiy
+# All Rights Reserved.
+
+# This work is dual-licensed under AGPL defined in file 'LICENSE' with
+# LICENSE_EXCEPTION and the Commercial license defined in file 'COMM_LICENSE',
+# which is part of this source code package.
+from typing import Any, Optional, Union
+
+
+class ThisMethod:
+    """
+    Reference to a method for forward references in class bodies.
+
+    This class is used to defer the resolution of a method reference until the
+    class is fully constructed. This is particularly useful in workflow or state
+    machine implementations where the flow references are declared before the
+    methods are defined.
+    """
+
+    def __init__(self, propname: str, methodname: str):
+        self._propname = propname
+        self._methodname = methodname
+
+    def resolve(self, instance) -> Any:
+        """
+        Resolve the method reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the method.
+
+        Returns:
+            Any: The result of the resolved method call.
+
+        Raises:
+            AttributeError: If the property or method does not exist on the instance.
+        """
+        prop = getattr(instance, self._propname)
+        method = getattr(instance, f"_this_{self._methodname}")
+        return method(prop)
+
+
+class ThisObject(object):
+    """
+    Helper for forward references to class attributes.
+
+    This class is used to defer the resolution of an attribute reference until
+    the class is fully constructed. This allows for the use of class attributes
+    before they are defined.
+
+    Attributes:
+        name (str): The name of the attribute to resolve.
+    """
+
+    def __init__(self, name: str) -> None:  # noqa D102
+        self.name = name
+
+    def resolve(self, instance: object) -> Any:
+        """
+        Resolve the attribute reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the attribute.
+
+        Returns:
+            Any: The resolved attribute.
+
+        Raises:
+            AttributeError: If the attribute does not exist on the instance.
+        """
+        return getattr(instance, self.name)
+
+    # def __copy__(self):
+    #     return super().__copy__()
+
+    # def __deepcopy__(self, memo):
+    #     return super().__deepcopy__(memo)
+
+    def __getattr__(self, name):
+        if name.startswith("__"):
+            super().__getattr__(name)
+        return ThisMethod(self.name, name)
+
+
+class This:
+    """
+    Helper for building forward references to class attributes and methods.
+
+    The rationale is the ability to specify references to the class attributes and
+    methods before they are declared. `this` acts similarly to `self`, but for
+    class-level forward references.
+    """
+
+    def resolve(self, instance: object, this_ref: Union[ThisObject, ThisMethod, Any]):
+        """
+        Resolve a forward reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the reference.
+            this_ref (Union[ThisObject, ThisMethod, Any]): The reference to resolve.
+
+        Returns:
+            Any: The resolved reference.
+
+        Raises:
+            AttributeError: If the reference cannot be resolved.
+        """
+        if isinstance(this_ref, (ThisObject, ThisMethod)):
+            return this_ref.resolve(instance)
+        else:
+            return this_ref
+
+    def __getattr__(self, name):
+        return ThisObject(name)
+
+
+# Instantiate a global `this` object for use in class definitions.
+this = This()