Skip to content

Commit 2738699

Browse files
committed
Updated installation docs
1 parent 7ff6c26 commit 2738699

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

README.rst

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ GeoIP2 databases have not yet been released as a downloadable product.
2121
Installation
2222
------------
2323

24+
Web Service Client Only
25+
^^^^^^^^^^^^^^^^^^^^^^^
26+
2427
To install the `geoip2` module, type:
2528

2629
.. code-block:: bash
2730
28-
$ pip install geoip2[DB]
29-
30-
If you do not need the database reader, you may omit `[DB]`.
31+
$ pip install geoip2
3132
3233
If you are not able to use pip, you may also use easy_install from the
3334
source directory:
@@ -36,6 +37,30 @@ source directory:
3637
3738
$ easy_install .
3839
40+
Database Reader and Web Service Client
41+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
43+
You must first install the `libmaxminddb C API
44+
<https://github.com/maxmind/libmaxminddb>`_. Please `see the instructions
45+
distributed with it <https://github.com/maxmind/libmaxminddb/blob/master/README.md#installing-from-a-tarball>`_.
46+
47+
After installing `libmaxminddb`, install the `geoip2` module with the database
48+
reader dependencies by typing:
49+
50+
.. code-block:: bash
51+
52+
$ pip install geoip2[DB]
53+
54+
If you are not able to use pip, you may also use easy_install. To do this, you
55+
must first install `maxminddb<maxminddb.readthedocs.org>`_ and
56+
`requests<http://www.python-requests.org/en/latest/>`_. Once these
57+
dependencies have been satisfied, `cd` to the source directory and type:
58+
59+
.. code-block:: bash
60+
61+
$ easy_install .
62+
63+
3964
Usage
4065
-----
4166

0 commit comments

Comments
 (0)