README.rst 1.23 KB
Newer Older
1 2 3
Pure Python GeoIP API
=====================

4
This library is based on `Maxmind's GeoIP C API <https://github.com/maxmind/geoip-api-c>`__.
5

6
Tested with Python version 2.6, 2.7, 3.2 and 3.3.
7

William Tisäter committed
8
|Build Status| |Coverage Status| |Downloads|
9 10 11 12 13 14

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

You can easily install pygeoip from PyPi.

15
.. code:: python
16 17 18 19 20 21 22 23 24 25 26 27

    pip install pygeoip

Issues and Contribution
-----------------------

Bug reports are done by `creating an issue on
Github <https://github.com/appliedsec/pygeoip/issues>`__. If you want to
contribute you can always `create a pull
request <https://github.com/appliedsec/pygeoip/pulls>`__ for discussion
and code submission.

28 29
Documentation
-------------
30

31 32
.. toctree::
   :maxdepth: 1
33

34 35 36
   getting-started
   supported-databases
   api-reference
37

38
For more information, `check out the documentation <http://pygeoip.readthedocs.org/>`__ over at Read the Docs.
39 40

.. |Build Status| image:: https://api.travis-ci.org/appliedsec/pygeoip.png?branch=master
41
	:target: https://travis-ci.org/appliedsec/pygeoip
William Tisäter committed
42
.. |Coverage Status| image:: https://coveralls.io/repos/appliedsec/pygeoip/badge.png
43
	:target: https://coveralls.io/r/appliedsec/pygeoip
William Tisäter committed
44
.. |Downloads| image:: https://pypip.in/d/pygeoip/badge.png
45
	:target: https://crate.io/packages/pygeoip