Louvain Community Detection
===========================

Installing
----------

To build and install run from source::

     python setup.py install

You can also install from pip with::

    pip install python-louvain


The package name on pip is `python-louvain` but it is imported as `community`
in python. You will find documentation about this module at
http://python-louvain.readthedocs.io/


Usage
-----

To use from the command line::

     $ community <filename>

filename is a binary file as generated by the
convert utility distributed with the C implementation

To use as a python library::

     import community

Documentation
-------------

You can find documentation at https://python-louvain.readthedocs.io/

To generate documentation run::

     pip install numpydoc sphinx
     cd docs
     make

Tests
-----

To run tests::

     pip install nose
     python setup.py test


.. image:: https://travis-ci.org/taynaud/python-louvain.svg?branch=master
    :target: https://travis-ci.org/taynaud/python-louvain


.. image:: https://readthedocs.org/projects/python-louvain/badge/?version=latest
    :target: http://python-louvain.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
