Skip to content

Commit

Permalink
Add installation instructions and usage examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jciskey committed May 8, 2017
1 parent 9c1ebb8 commit f5dc397
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# pygraph
A graph manipulation library in pure Python

Available on [PyPI](https://pypi.python.org/pypi/pygraph)

Pygraph aims to be an easy-to-use and functional graph library that doesn't sacrifice advanced capabilities or usability in the process.

By implementing the library in pure Python, it can be installed without any dependencies aside from the Python core, enabling maximum ease of use.
Expand Down Expand Up @@ -42,6 +44,16 @@ Planar Embedding | :x: Unsupported
Fully-Dynamic Planarity Testing | :x: Unsupported


## Installation && Usage
Installing the module is as easy as `pip install pygraph`

```python
>>> import pygraph
>>> g = pygraph.build_chvatal_graph()
>>> pygraph.is_planar(g)
False
```

## Running the Test Suite
The entire test suite is written using the standard library unittest module, so you should be able to run it with whichever framework you most prefer. We recommend [nose](http://nose.readthedocs.io/).

Expand Down

0 comments on commit f5dc397

Please sign in to comment.