nxviz 0.5.0

Graph Visualization Package

===============================
nxviz
===============================

.. image:: https://badges.gitter.im/ericmjl/nxviz.svg
:alt: Join the chat at https://gitter.im/ericmjl/nxviz
:target: https://gitter.im/ericmjl/nxviz

.. image:: https://img.shields.io/pypi/v/nxviz.svg
:target: https://pypi.python.org/pypi/nxviz

.. image:: https://img.shields.io/travis/ericmjl/nxviz.svg
:target: https://travis-ci.org/ericmjl/nxviz

.. image:: https://readthedocs.org/projects/nxviz/badge/?version=latest
:target: https://nxviz.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/ericmjl/nxviz/shield.svg
:target: https://pyup.io/repos/github/ericmjl/nxviz/
:alt: Updates

.. image:: https://pyup.io/repos/github/ericmjl/nxviz/python-3-shield.svg
:target: https://pyup.io/repos/github/ericmjl/nxviz/
:alt: Python 3


`nxviz` is a graph visualization package for NetworkX. With nxviz, you can create beautiful graph visualizations by a **declarative** API. Here's an example.

.. code:: python

# Assume we have a professional network of physicians belonging to hospitals.
c = CircosPlot(G, node_color='affiliation', node_grouping='affiliation')
c.draw()
plt.show() # only needed in scripts

* This is free software distributed under the MIT License.

Installation
------------

We recommend using conda_.

.. code:: bash

$ conda install nxviz

Alternatively, it is also available on PyPI_.

.. code:: bash

$ pip install nxviz

.. _conda: https://www.anaconda.com/download/
.. _PyPI: https://pypi.python.org/pypi/nxviz

Requirements
------------

For requirements, consult the `requirements.txt` file in the GitHub repository. As a matter of practice, nxviz development will try (where relevant) to take advantage of the latest Python features. As of 18 September 2017, this means Python 3.6 is the "officially" supported version, as there are places where we use f-string formatting to simplify logging and debugging.

Features
--------

* Declarative API.
* Works with NetworkX, one of the more popular graph libraries in Python.
* Can build NetworkX graphs from a pandas DataFrame

Feature Requests
----------------

If you have a feature request, please post it as an issue on the GitHub repository issue_ tracker. Even better, put in a PR_ for it! I am more than happy to guide you through the codebase so that you can put in a contribution to the codebase - and I'll give you a digital `nxviz` contributor badge that you can put on your personal website, as a way of saying thanks!

Because nxviz is currently maintained by volunteers and has no fiscal support, any feature requests will be prioritized according to what maintainers encounter as a need in our day-to-day jobs. Please temper expectations accordingly.

.. _issue: https://github.com/ericmjl/nxviz/issues
.. _PR: https://github.com/ericmjl/nxviz/pulls

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.3.7 (2018-XX-XX)
------------------

* Node labels in CircosPlot can now be rotated with the `rotate_labels`
argument.

0.3.6 (2018-02-20)
------------------

* Implemented edge colours, thanks to @noragak.

0.3.5 (2018-01-20)
------------------

* Disabled health checks on certain tests.
* Added ability to configure plot size.
* Added docs on preparing a new release.
* Updated dependencies.

0.3.2 (2017-09-18)
------------------

* All plots except for HivePlot are implemented.
* Implemented auto-colorbar for plots that have continuous node colors.

0.1.0 (2016-07-15)
------------------

* First release on PyPI.