dash-cytoscape

Dash Cytoscape

A Component Library for Dash aimed at facilitating network visualization in Python, wrapped around Cytoscape.js.

Interacting with the stylesheet:

Interacting with the elements:

Getting Started

Prerequisites

Make sure that dash and its dependent libraries are correctly installed:

pip install dash dash-html-components

If you want to install the latest versions, check out the Dash docs on installation.

Usage

Install the library using pip:

pip install dash-cytoscape

Create the following example inside an app.py file:

import dash
import dash_cytoscape as cyto
import dash_html_components as html

app = dash.Dash(__name__)
app.layout = html.Div([
    cyto.Cytoscape(
        id='cytoscape',
        elements=[
            {'data': {'id': 'one', 'label': 'Node 1'}, 'position': {'x': 50, 'y': 50}},
            {'data': {'id': 'two', 'label': 'Node 2'}, 'position': {'x': 200, 'y': 200}},
            {'data': {'source': 'one', 'target': 'two','label': 'Node 1 to 2'}}
        ],
        layout={'name': 'preset'}
    )
])

if __name__ == '__main__':
    app.run_server(debug=True)

Documentation

View the Dash Cytoscape User Guide to get started now. You can also use the component reference to find how to use a certain feature.

To learn more about the core Dash components and how to use callbacks, view the Dash documentation.

For supplementary information about the underlying Javascript API, view the Cytoscape.js documentation.

Development and Contributions

Make sure that you have read and understood our code of conduct, then head over to CONTRIBUTING to get started.

License

Dash, Cytoscape.js and Dash Cytoscape are licensed under MIT. Please view LICENSE for more details.

Contact and Support

See https://plot.ly/dash/support for ways to get in touch.

Acknowledgments

Huge thanks to the Cytoscape Consortium and the Cytoscape.js team for their contribution in making such a complete API for creating interactive networks. This library would not have been possible without their massive work!

The Pull Request and Issue Templates were inspired from the scikit-learn project.

Changelog

[0.0.5] - 2019-03-08

Added

• Two new demos: usage-grid-social-network.py and usage-concentric-social-network.py
• Add Issue and PR templates for Github (located in .github)
• tests.test_usage: Tests for rendering usage files.
• tests.test_callbacks: Tests for updating Cytoscape with callbacks.
• tests.test_interactions: Tests for interacting with Cytoscape, and evaluating its event callbacks.
• tests.test_percy_snapshot: Creates a Percy build using screenshots from other tests.

Changed

• usage-*.py: Modified all the import statements from import dash_cytoscape to import dash_cytoscape as cyto. Optimized imports. They are now linted with pylint/flake8.
• demos/usage-*: Formatted all demo apps in order to respect pylint and flake8.
• usage-phylogeny.py: Clear callback conditional statement
• CONTRIBUTING.md: changed dash-cytoscape-0.0.1 to dash-cytoscape-x.x.x. Added a Code quality & design section. Changed the Making a contribution section and updated title to Publishing. Updated Pre-Release checklist. Added the Development section from README.md (renamed Setting up the environment). Added a Tests section.
• npmignore: Added venv to avoid venvs to be included in the npm distribution package, which makes us a large amount of space and many unnecessary files being distributed.
• config.yml: Added steps to run the new tests. Added coverage for Python 3.7. Included demos and all usage examples in pylint and flake8. Increased line limit to 100.
• README.md: Moved the Development section to CONTRIBUTING.md. Modified the dash version in Prerequisites.
• requirements.txt: Updated the dash version to latest.
• tests/requiremens.txt: Updated the dash version to latest.
• package.json: Removed "prepublish": "npm run validate-init" due to conflict with CircleCI build. This script will be deprecated in favor of the upcoming Dash Component CLI.
• tests/IntegrationTests.py: Moved the percy_snapshot method to test_percy_snapshot in order to avoid duplicate (failing) builds on Percy. Decrease the number of processes to 1.
• setup.py: Added classifiers and download_url.

Removed

• extract-meta.js, extract-meta - they were moved to the dash component CLI, thus are not needed anymore
• config.py, runtime.txt, Procfile, index.html - only needed for hosting usage-*.py on DDS, they are now moved to plotly/dash-cytoscape-demos.
• review_checklist.md - redundant since all the information is already contained in CONTRIBUTING.md
• tests.test_render: Removed unused test