dash-flows 0.0.2__tar.gz → 0.0.4__tar.gz

dash_flows-0.0.4/MANIFEST.in

@@ -0,0 +1,11 @@
+include dash_flows/dash_flows.min.js
+include dash_flows/dash_flows.min.js.map
+include dash_flows/async-*.js
+include dash_flows/async-*.js.map
+include dash_flows/*-shared.js
+include dash_flows/*-shared.js.map
+include dash_flows/metadata.json
+include dash_flows/package-info.json
+include README.md
+include LICENSE
+include package.json

{dash_flows-0.0.2 → dash_flows-0.0.4}/PKG-INFO

@@ -1,18 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dash_flows
-Version: 0.0.2
-Summary: A Dash component library for creating interactive node-based interfaces with React Flow
+Version: 0.0.4
+Summary: React Flow for the Plotly Dash framework with edittable handles.
 Author: Pip Install Python <pipinstallpython@gmail.com>
 License: MIT
 Classifier: Framework :: Dash
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: summary
 
-# Dash Flow
+# Dash Flows
 
-Dash Flow is a Dash component library.
+Dash Flows is a Dash component library.
 
-A Dash component library for creating interactive node-based interfaces with React Flow
+React Flow for the Plotly Dash framework.
 
 Get started with:
 1. Install Dash and its dependencies: https://dash.plotly.com/installation
@@ -47,7 +53,7 @@ If you have selected install_dependencies during the prompt, you can skip this p
     $ pip install -r tests/requirements.txt
     ```
 
-### Write your component code in `src/lib/components/DashFlow.react.js`.
+### Write your component code in `src/lib/components/DashFlows.react.js`.
 
 - The demo app is in `src/demo` and you will import your example component code into your demo app.
 - Test your code in a Python environment:
@@ -63,9 +69,9 @@ If you have selected install_dependencies during the prompt, you can skip this p
     - A sample test is available in `tests/test_usage.py`, it will load `usage.py` and you can then automate interactions with selenium.
     - Run the tests with `$ pytest tests`.
     - The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
-- Add custom styles to your component by putting your custom CSS files into your distribution folder (`dash_flow`).
+- Add custom styles to your component by putting your custom CSS files into your distribution folder (`dash_flows`).
     - Make sure that they are referenced in `MANIFEST.in` so that they get properly included when you're ready to publish your component.
-    - Make sure the stylesheets are added to the `_css_dist` dict in `dash_flow/__init__.py` so dash will serve them automatically when the component suite is requested.
+    - Make sure the stylesheets are added to the `_css_dist` dict in `dash_flows/__init__.py` so dash will serve them automatically when the component suite is requested.
 - [Review your code](./review_checklist.md)
 
 ### Create a production build and publish:
@@ -84,7 +90,7 @@ If you have selected install_dependencies during the prompt, you can skip this p
 
 3. Test your tarball by copying it into a new environment and installing it locally:
     ```
-    $ pip install dash_flow-0.0.1.tar.gz
+    $ pip install dash_flows-0.0.3.tar.gz
     ```
 
 4. If it works, then you can publish the component to NPM and PyPI:

dash_flows-0.0.4/README.md

@@ -0,0 +1,98 @@
+# Dash Flows
+
+Dash Flows is a Dash component library.
+
+React Flow for the Plotly Dash framework.
+
+Get started with:
+1. Install Dash and its dependencies: https://dash.plotly.com/installation
+2. Run `python usage.py`
+3. Visit http://localhost:8050 in your web browser
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+### Install dependencies
+
+If you have selected install_dependencies during the prompt, you can skip this part.
+
+1. Install npm packages
+    ```
+    $ npm install
+    ```
+2. Create a virtual env and activate.
+    ```
+    $ virtualenv venv
+    $ . venv/bin/activate
+    ```
+    _Note: venv\Scripts\activate for windows_
+
+3. Install python packages required to build components.
+    ```
+    $ pip install -r requirements.txt
+    ```
+4. Install the python packages for testing (optional)
+    ```
+    $ pip install -r tests/requirements.txt
+    ```
+
+### Write your component code in `src/lib/components/DashFlows.react.js`.
+
+- The demo app is in `src/demo` and you will import your example component code into your demo app.
+- Test your code in a Python environment:
+    1. Build your code
+        ```
+        $ npm run build
+        ```
+    2. Run and modify the `usage.py` sample dash app:
+        ```
+        $ python usage.py
+        ```
+- Write tests for your component.
+    - A sample test is available in `tests/test_usage.py`, it will load `usage.py` and you can then automate interactions with selenium.
+    - Run the tests with `$ pytest tests`.
+    - The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
+- Add custom styles to your component by putting your custom CSS files into your distribution folder (`dash_flows`).
+    - Make sure that they are referenced in `MANIFEST.in` so that they get properly included when you're ready to publish your component.
+    - Make sure the stylesheets are added to the `_css_dist` dict in `dash_flows/__init__.py` so dash will serve them automatically when the component suite is requested.
+- [Review your code](./review_checklist.md)
+
+### Create a production build and publish:
+
+1. Build your code:
+    ```
+    $ npm run build
+    ```
+2. Create a Python distribution
+    ```
+    $ python setup.py sdist bdist_wheel
+    ```
+    This will create source and wheel distribution in the generated the `dist/` folder.
+    See [PyPA](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project)
+    for more information.
+
+3. Test your tarball by copying it into a new environment and installing it locally:
+    ```
+    $ pip install dash_flows-0.0.3.tar.gz
+    ```
+
+4. If it works, then you can publish the component to NPM and PyPI:
+    1. Publish on PyPI
+        ```
+        $ twine upload dist/*
+        ```
+    2. Cleanup the dist folder (optional)
+        ```
+        $ rm -rf dist
+        ```
+    3. Publish on NPM (Optional if chosen False in `publish_on_npm`)
+        ```
+        $ npm publish
+        ```
+        _Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS locally, but if you choose to publish the package to NPM you can set `serve_locally` to `False` and you may see faster load times._
+
+5. Share your component with the community! https://community.plotly.com/c/dash
+    1. Publish this repository to GitHub
+    2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
+    3. Create a post in the Dash community forum: https://community.plotly.com/c/dash

dash_flows-0.0.4/dash_flows/AnimatedCircleNode.py

@@ -0,0 +1,55 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+class AnimatedCircleNode(Component):
+    """An AnimatedCircleNode component.
+
+
+Keyword arguments:
+
+- data (dict; required)
+
+    `data` is a dict with keys:
+
+    - label (boolean | number | string | dict | list; optional)"""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_flows'
+    _type = 'AnimatedCircleNode'
+    Data = TypedDict(
+        "Data",
+            {
+            "label": NotRequired[typing.Any]
+        }
+    )
+
+    @_explicitize_args
+    def __init__(
+        self,
+        data: typing.Optional["Data"] = None,
+        **kwargs
+    ):
+        self._prop_names = ['data']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['data']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        for k in ['data']:
+            if k not in args:
+                raise TypeError(
+                    'Required argument `' + k + '` was not specified.')
+
+        super(AnimatedCircleNode, self).__init__(**args)

dash_flows-0.0.4/dash_flows/AnimatedNodeEdge.py

@@ -0,0 +1,80 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+class AnimatedNodeEdge(Component):
+    """An AnimatedNodeEdge component.
+AnimatedNodeEdge is a custom edge component that animates a node along its path.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID of the edge.
+
+- data (dict; default { animatedNode: '' }):
+    Edge data containing the ID of the node to animate.
+
+    `data` is a dict with keys:
+
+    - animatedNode (string; optional):
+        ID of the node to animate along this edge.
+
+- sourcePosition (string; optional):
+    Position of the source handle.
+
+- sourceX (number; optional):
+    X coordinate of the source node.
+
+- sourceY (number; optional):
+    Y coordinate of the source node.
+
+- targetPosition (string; optional):
+    Position of the target handle.
+
+- targetX (number; optional):
+    X coordinate of the target node.
+
+- targetY (number; optional):
+    Y coordinate of the target node."""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_flows'
+    _type = 'AnimatedNodeEdge'
+    Data = TypedDict(
+        "Data",
+            {
+            "animatedNode": NotRequired[str]
+        }
+    )
+
+    @_explicitize_args
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        data: typing.Optional["Data"] = None,
+        sourceX: typing.Optional[typing.Union[int, float, numbers.Number]] = None,
+        sourceY: typing.Optional[typing.Union[int, float, numbers.Number]] = None,
+        targetX: typing.Optional[typing.Union[int, float, numbers.Number]] = None,
+        targetY: typing.Optional[typing.Union[int, float, numbers.Number]] = None,
+        sourcePosition: typing.Optional[str] = None,
+        targetPosition: typing.Optional[str] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'data', 'sourcePosition', 'sourceX', 'sourceY', 'targetPosition', 'targetX', 'targetY']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'data', 'sourcePosition', 'sourceX', 'sourceY', 'targetPosition', 'targetX', 'targetY']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(AnimatedNodeEdge, self).__init__(**args)

dash_flows-0.0.4/dash_flows/DashFlows.py

@@ -0,0 +1,168 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+class DashFlows(Component):
+    """A DashFlows component.
+
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- className (string; default ''):
+    CSS class name for the container div.
+
+- edges (list of dicts; optional):
+    Array of edges defining connections between nodes.
+
+    `edges` is a list of dicts with keys:
+
+    - id (string; required)
+
+    - source (string; required)
+
+    - target (string; required)
+
+    - type (string; optional)
+
+    - data (dict; optional)
+
+    - style (dict; optional)
+
+    - markerEnd (dict; optional)
+
+        `markerEnd` is a dict with keys:
+
+        - type (string; required)
+
+        - color (string; optional)
+
+        - size (number; optional)
+
+- elementsSelectable (boolean; default True):
+    Enable/disable the ability to select elements.
+
+- layoutOptions (string; optional):
+    Layout options for arranging nodes using the ELK layout engine.
+
+- nodes (list of dicts; optional):
+    Array of nodes to display in the flow.
+
+    `nodes` is a list of dicts with keys:
+
+    - id (string; required)
+
+    - type (string; optional)
+
+    - data (dict; required)
+
+    - position (dict; required)
+
+        `position` is a dict with keys:
+
+        - x (number; required)
+
+        - y (number; required)
+
+    - style (dict; optional)
+
+- nodesConnectable (boolean; default True):
+    Enable/disable the ability to make new connections between nodes.
+
+- nodesDraggable (boolean; default True):
+    Enable/disable node dragging behavior.
+
+- showBackground (boolean; default True):
+    Show/hide the background pattern.
+
+- showControls (boolean; default True):
+    Show/hide the control panel.
+
+- showDevTools (boolean; default False):
+    Show/hide the developer tools panel.
+
+- showMiniMap (boolean; default True):
+    Show/hide the minimap navigation component."""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_flows'
+    _type = 'DashFlows'
+    NodesPosition = TypedDict(
+        "NodesPosition",
+            {
+            "x": typing.Union[int, float, numbers.Number],
+            "y": typing.Union[int, float, numbers.Number]
+        }
+    )
+
+    Nodes = TypedDict(
+        "Nodes",
+            {
+            "id": str,
+            "type": NotRequired[str],
+            "data": dict,
+            "position": "NodesPosition",
+            "style": NotRequired[dict]
+        }
+    )
+
+    EdgesMarkerEnd = TypedDict(
+        "EdgesMarkerEnd",
+            {
+            "type": str,
+            "color": NotRequired[str],
+            "size": NotRequired[typing.Union[int, float, numbers.Number]]
+        }
+    )
+
+    Edges = TypedDict(
+        "Edges",
+            {
+            "id": str,
+            "source": str,
+            "target": str,
+            "type": NotRequired[str],
+            "data": NotRequired[dict],
+            "style": NotRequired[dict],
+            "markerEnd": NotRequired["EdgesMarkerEnd"]
+        }
+    )
+
+    @_explicitize_args
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        nodesDraggable: typing.Optional[bool] = None,
+        nodesConnectable: typing.Optional[bool] = None,
+        elementsSelectable: typing.Optional[bool] = None,
+        showMiniMap: typing.Optional[bool] = None,
+        showControls: typing.Optional[bool] = None,
+        showBackground: typing.Optional[bool] = None,
+        nodes: typing.Optional[typing.Sequence["Nodes"]] = None,
+        edges: typing.Optional[typing.Sequence["Edges"]] = None,
+        style: typing.Optional[typing.Any] = None,
+        className: typing.Optional[str] = None,
+        showDevTools: typing.Optional[bool] = None,
+        layoutOptions: typing.Optional[str] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'className', 'edges', 'elementsSelectable', 'layoutOptions', 'nodes', 'nodesConnectable', 'nodesDraggable', 'showBackground', 'showControls', 'showDevTools', 'showMiniMap', 'style']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'className', 'edges', 'elementsSelectable', 'layoutOptions', 'nodes', 'nodesConnectable', 'nodesDraggable', 'showBackground', 'showControls', 'showDevTools', 'showMiniMap', 'style']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(DashFlows, self).__init__(**args)

dash_flows-0.0.4/dash_flows/DevTools.py

@@ -0,0 +1,80 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+class DevTools(Component):
+    """A DevTools component.
+DevTools component for displaying debug information about the flow
+
+Keyword arguments:
+
+- nodes (list of dicts; required):
+    Array of nodes to display information about.
+
+    `nodes` is a list of dicts with keys:
+
+    - id (string; required)
+
+    - type (string; optional)
+
+- viewport (dict; required):
+    Current viewport information including position and zoom level.
+
+    `viewport` is a dict with keys:
+
+    - x (number; required)
+
+    - y (number; required)
+
+    - zoom (number; required)"""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_flows'
+    _type = 'DevTools'
+    Viewport = TypedDict(
+        "Viewport",
+            {
+            "x": typing.Union[int, float, numbers.Number],
+            "y": typing.Union[int, float, numbers.Number],
+            "zoom": typing.Union[int, float, numbers.Number]
+        }
+    )
+
+    Nodes = TypedDict(
+        "Nodes",
+            {
+            "id": str,
+            "type": NotRequired[str]
+        }
+    )
+
+    @_explicitize_args
+    def __init__(
+        self,
+        viewport: typing.Optional["Viewport"] = None,
+        nodes: typing.Optional[typing.Sequence["Nodes"]] = None,
+        **kwargs
+    ):
+        self._prop_names = ['nodes', 'viewport']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['nodes', 'viewport']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        for k in ['nodes', 'viewport']:
+            if k not in args:
+                raise TypeError(
+                    'Required argument `' + k + '` was not specified.')
+
+        super(DevTools, self).__init__(**args)

dash_flows-0.0.4/dash_flows/ResizableNode.py

@@ -0,0 +1,96 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+class ResizableNode(Component):
+    """A ResizableNode component.
+
+
+Keyword arguments:
+
+- data (dict; required)
+
+    `data` is a dict with keys:
+
+    - label (boolean | number | string | dict | list; optional)
+
+    - handles (list of dicts; required)
+
+        `handles` is a list of dicts with keys:
+
+        - id (string; required)
+
+        - type (string; required)
+
+        - position (string; required)
+
+        - style (dict; optional)
+
+        - isConnectable (boolean; optional)
+
+        - isConnectableStart (boolean; optional)
+
+        - isConnectableEnd (boolean; optional)
+
+        - onConnect (optional)
+
+        - isValidConnection (optional)
+
+- selected (boolean; default False)"""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_flows'
+    _type = 'ResizableNode'
+    DataHandles = TypedDict(
+        "DataHandles",
+            {
+            "id": str,
+            "type": str,
+            "position": str,
+            "style": NotRequired[dict],
+            "isConnectable": NotRequired[bool],
+            "isConnectableStart": NotRequired[bool],
+            "isConnectableEnd": NotRequired[bool],
+            "onConnect": NotRequired[typing.Any],
+            "isValidConnection": NotRequired[typing.Any]
+        }
+    )
+
+    Data = TypedDict(
+        "Data",
+            {
+            "label": NotRequired[typing.Any],
+            "handles": typing.Sequence["DataHandles"]
+        }
+    )
+
+    @_explicitize_args
+    def __init__(
+        self,
+        data: typing.Optional["Data"] = None,
+        selected: typing.Optional[bool] = None,
+        **kwargs
+    ):
+        self._prop_names = ['data', 'selected']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['data', 'selected']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        for k in ['data']:
+            if k not in args:
+                raise TypeError(
+                    'Required argument `' + k + '` was not specified.')
+
+        super(ResizableNode, self).__init__(**args)