dash-flows 0.0.2__tar.gz

dash_flows-0.0.2/MANIFEST.in

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

dash_flows-0.0.2/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: dash_flows
+Version: 0.0.2
+Summary: A Dash component library for creating interactive node-based interfaces with React Flow
+Author: Pip Install Python <pipinstallpython@gmail.com>
+License: MIT
+Classifier: Framework :: Dash
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Dash Flow
+
+Dash Flow is a Dash component library.
+
+A Dash component library for creating interactive node-based interfaces with React Flow
+
+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/DashFlow.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_flow`).
+    - 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.
+- [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_flow-0.0.1.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.2/README.md

@@ -0,0 +1,169 @@
+# Dash-Flow
+
+A Dash component library that integrates React Flow functionality into Dash applications, enabling interactive node-based interfaces with support for animated edges, resizable nodes, and custom components.
+
+## Features
+
+- ✨ Interactive node-based diagrams
+- 🎯 Animated edges with node movement
+- 📏 Resizable nodes with custom content
+- 🎨 Custom node and edge styling
+- 🔧 Developer tools for debugging
+- 🖼️ Support for images and custom components
+- 🎮 Interactive controls and minimap
+- 🌈 Background customization
+
+
+### Prerequisites
+
+- Python 3.6+
+- Dash 2.0+
+- React 18.2.0+
+
+## Quick Start
+
+```python
+import dash
+from dash import html
+import dash_flow
+import dash_mantine_components as dmc
+
+app = dash.Dash(__name__)
+
+# Define your nodes
+nodes = [
+    {
+        'id': '1',
+        'type': 'resizable',
+        'data': {
+            'label': html.Div([
+                html.Img(src="your-image-url", 
+                        style={'width': '100%', 'height': '100%'})
+            ])
+        },
+        'position': {'x': 250, 'y': 25},
+        'style': {
+            'width': 300,
+            'height': 300,
+        }
+    }
+]
+
+# Define your edges
+edges = [
+    {
+        'id': 'e1-2',
+        'source': '1',
+        'target': '2',
+        'type': 'animated',
+        'data': {
+            'animatedNode': '3'  # Node to animate along this edge
+        }
+    }
+]
+
+# Create the layout
+app.layout = dmc.MantineProvider([
+    dash_flow.DashFlow(
+        id='react-flow-example',
+        nodes=nodes,
+        edges=edges,
+        showDevTools=True,
+        style={'height': '600px'}
+    )
+])
+
+if __name__ == '__main__':
+    app.run_server(debug=True)
+```
+
+## Components
+
+### DashFlow
+
+Main component that wraps React Flow functionality.
+
+#### Props
+
+- `id` (string): Component identifier
+- `nodes` (list): Array of node objects
+- `edges` (list): Array of edge objects
+- `nodesDraggable` (boolean): Enable/disable node dragging
+- `nodesConnectable` (boolean): Enable/disable creating connections
+- `elementsSelectable` (boolean): Enable/disable selection
+- `showMiniMap` (boolean): Show/hide minimap
+- `showControls` (boolean): Show/hide controls
+- `showBackground` (boolean): Show/hide background
+- `showDevTools` (boolean): Show/hide developer tools
+- `style` (dict): Custom container styles
+
+### Node Types
+
+#### ResizableNode
+
+A node type that supports resizing and custom content.
+
+```python
+node = {
+    'id': '1',
+    'type': 'resizable',
+    'data': {
+        'label': html.Div([...])  # Custom content
+    },
+    'position': {'x': 0, 'y': 0},
+    'style': {
+        'width': 300,
+        'height': 300
+    }
+}
+```
+
+### Edge Types
+
+#### AnimatedNodeEdge
+
+An edge type that animates a node along its path.
+
+```python
+edge = {
+    'id': 'e1-2',
+    'source': '1',
+    'target': '2',
+    'type': 'animated',
+    'data': {
+        'animatedNode': '3'  # ID of node to animate
+    }
+}
+```
+
+## Development
+
+To contribute to this project:
+
+1. Clone the repository
+```bash
+git clone https://github.com/yourusername/dash-flow.git
+```
+
+2. Install dependencies
+```bash
+npm install
+pip install -r requirements.txt
+```
+
+3. Run the development server
+```bash
+npm start
+python usage.py
+```
+
+## Building the Component
+
+```bash
+npm run build
+```
+
+## License
+
+MIT © [Pip Install Python](https://github.com/pip-install-python)
+