Installing Dragon Mapper is easy. Make sure you have Python 2.7 or 3 along with Zhon and Hanzi Identifier. Then use pip:

$ pip install dragonmapper

That will download Dragon Mapper from the Python Package Index and install it in your Python’s site-packages directory.

Tarball Release

If you’d rather install Dragon Mapper manually:

  1. Download the most recent release from Dragon Mapper’s PyPi page.
  2. Unpack the tarball.
  3. From inside the directory dragonmapper-XX, run python install

That will install Dragon Mapper in your Python’s site-packages directory.

Install the Development Version

Dragon Mapper’s code is hosted at GitHub. To install the development version first make sure Git is installed. Then run:

$ git clone git://
$ pip install -e dragonmapper

This will link the dragonmapper directory into your site-packages directory.

Running the Tests

Running the tests is easy:

$ python test

If you want to run the tests using multiple versions of Python, install and run tox:

$ pip install tox
$ tox

Dragon Mapper’s tox.ini file is configured to run tests using Python 2.7, 3.3, and 3.4. It will also build the documentation (requires Sphinx).