diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1caf8b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +# binaries +*.pyc +.cache/ +.coverage + +# notebook checkpoints +.ipynb_checkpoints/ +notebooks/.ipynb_checkpoints + +# test related +.pytest_cache/ +pyvis/test.py + +# local files +pyvis/full_graph.txt +pyvis/source/stormofswords.csv + +# package details +pyvis.egg-info/ +build/ +dist/ +pyvis/make.bat + +# vscode specific +.vscode/ +venv + +# intellij specific +.idea/ \ No newline at end of file diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..dd8ca9a --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.8.12/envs/dash-venv-3-8 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..10e4d7a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Pull Requests + +Here are some guidelines for pull requests: + +* All work is submitted via Pull Requests. +* Pull Requests can be submitted as soon as there is code worth discussing. The worst case is that the PR is closed. +* Pull Requests should be made against master +* Pull Requests should be tested, if feasible: + - bugfixes should include regression tests. + - new behavior should at least get minimal exercise. + - new features should include a screenshot +* Don't make 'cleanup' pull requests just to change code style. We don't follow any style guide strictly, and we consider formatting changes unnecessary noise. If you're making functional changes, you can clean up the specific pieces of code you're working on. + +Pyvis wraps vis.js so JavaScript functionality issues should be directed at the main `vis.js` project. + +# Other contributions + +Outside of Pull Requests (PRs), we welcome additions/corrections/clarification to the existing documentation as contributions at least as valuable as code submissions. diff --git a/LICENSE_BSD.txt b/LICENSE_BSD.txt index 6e3050f..024edb5 100644 --- a/LICENSE_BSD.txt +++ b/LICENSE_BSD.txt @@ -11,7 +11,7 @@ are permitted provided that the following conditions are met: this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - - Neither the name of Thomas J Bradley nor the names of its contributors may + - Neither the name of West Health Institute nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/MANIFEST.in b/MANIFEST.in index f297faf..5cdfb04 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,2 @@ -recursive-include pyvis/templates *.html \ No newline at end of file +recursive-include pyvis/templates * +recursive-include pyvis/lib * diff --git a/README.md b/README.md index 82a9972..0245196 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ ## Pyvis - a Python library for visualizing networks + + ## Description Pyvis is built around [visjs](http://visjs.org/), a JavaScript visualization library. @@ -24,6 +26,12 @@ python setup.py install [ipython](https://ipython.org/ipython-doc/2/install/install.html) +[jsonpickle](https://jsonpickle.github.io/) + +### Test Dependencies +[selenium](https://www.selenium.dev/documentation/webdriver/) + +[numpy](https://numpy.org/install/) ## Quick Start The most basic use case of a pyvis instance is to create a Network object and invoke methods: @@ -35,4 +43,7 @@ g.add_node(0) g.add_node(1) g.add_edge(0, 1) g.show("basic.html") -``` \ No newline at end of file +``` + +## Interactive Notebook playground with examples +[](https://mybinder.org/v2/gh/WestHealth/pyvis/master?filepath=notebooks%2Fexample.ipynb) diff --git a/examples/example.html b/examples/example.html new file mode 100644 index 0000000..280f2a7 --- /dev/null +++ b/examples/example.html @@ -0,0 +1,1609 @@ + + + +
+ + + + + +