1# Kartograph.py
2
3Kartograph is a Python library that generates SVG maps from ESRI shapefiles. Please have a look at the [API docs](https://github.com/kartograph/kartograph.py/wiki/API) for more details.
4
5### Author
6
7Kartograph was created by [Gregor Aisch](http://github.com/gka/) and is supported by [dpa-newslab](http://www.dpa-newslab.com/), [Piwik Web Analytics](http://piwik.org) and the [Open Knowledge Foundation](http://okfn.org).
8
9### License
10
11Kartograph.py is licensed under [AGPL](http://www.gnu.org/licenses/agpl-3.0.txt)
12
13### Current status
14
15Kartograph.py is still beta, which means that there are some bugs left to fix.
16
17However, feel free to test it while it is been developed. To do so I recommend to use [virtualenv](http://www.virtualenv.org/en/latest/index.html) and [virtualenv-wrapper](http://www.doughellmann.com/projects/virtualenvwrapper/).
18
19```sh
20> mkdir kartograph-py
21> git clone git@github.com:kartograph/kartograph.py.git kartograph-py
22
23# create and activate a new virtual environment
24> mkvirtualenv kartograph
25
26# install and use Kartograph
27(kartograph)> cd kartograph-py
28(kartograph)> python setup.py install
29```
30
31See install documentation
32