/usr/share/doc/python-maxminddb-doc/html/index.html is in python-maxminddb-doc 1.2.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MaxMind DB Python Module — maxminddb 1.2.3 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="maxminddb 1.2.3 documentation" href="#" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="#">maxminddb 1.2.3 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">MaxMind DB Python Module</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
<li><a class="reference internal" href="#exceptions">Exceptions</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#versioning">Versioning</a></li>
<li><a class="reference internal" href="#support">Support</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="toctree-wrapper compound">
</div>
<div class="section" id="maxmind-db-python-module">
<h1>MaxMind DB Python Module<a class="headerlink" href="#maxmind-db-python-module" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>This is a Python module for reading MaxMind DB files. The module includes both
a pure Python reader and an optional C extension.</p>
<p>MaxMind DB is a binary file format that stores data indexed by IP address
subnets (IPv4 or IPv6).</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>If you want to use the C extension, you must first install <a class="reference external" href="https://github.com/maxmind/libmaxminddb">libmaxminddb</a> C library installed before
installing this extension. If the library is not available, the module will
fall-back to a pure Python implementation.</p>
<p>To install maxminddb, type:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ pip install maxminddb
</pre></div>
</div>
<p>If you are not able to use pip, you may also use easy_install from the
source directory:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ easy_install .
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>To use this module, you must first download or create a MaxMind DB file. We
provide <a class="reference external" href="http://dev.maxmind.com/geoip/geoip2/geolite2">free GeoLite2 databases</a>. These files must be
decompressed with <code class="docutils literal"><span class="pre">gunzip</span></code>.</p>
<p>After you have obtained a database and importing the module, call
<code class="docutils literal"><span class="pre">open_database</span></code> with a path to the database as the first argument.
Optionally, you may pass a mode as the second arguments. The modes are
exported from <code class="docutils literal"><span class="pre">maxminddb</span></code>. Valid modes are:</p>
<ul class="simple">
<li>MODE_MMAP_EXT - use the C extension with memory map.</li>
<li>MODE_MMAP - read from memory map. Pure Python.</li>
<li>MODE_FILE - read database as standard file. Pure Python.</li>
<li>MODE_MEMORY - load database into memory. Pure Python.</li>
<li>MODE_AUTO - try MODE_MMAP_EXT, MODE_MMAP, MODE_FILE in that order. Default.</li>
</ul>
<p>The <code class="docutils literal"><span class="pre">open_database</span></code> function returns a <code class="docutils literal"><span class="pre">Reader</span></code> object. To look up an IP
address, use the <code class="docutils literal"><span class="pre">get</span></code> method on this object. The method will return the
corresponding values for the IP address from the database (e.g., a dictionary
for GeoIP2/GeoLite2 databases). If the database does not contain a record for
that IP address, the method will return <code class="docutils literal"><span class="pre">None</span></code>.</p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="highlight-pycon"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">maxminddb</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">reader</span> <span class="o">=</span> <span class="n">maxminddb</span><span class="o">.</span><span class="n">open_database</span><span class="p">(</span><span class="s1">'GeoLite2-City.mmdb'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">reader</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'1.1.1.1'</span><span class="p">)</span>
<span class="go">{'country': ... }</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">reader</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="exceptions">
<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h2>
<p>The module will return an <code class="docutils literal"><span class="pre">InvalidDatabaseError</span></code> if the database is corrupt
or otherwise invalid. A <code class="docutils literal"><span class="pre">ValueError</span></code> will be thrown if you look up an
invalid IP address or an IPv6 address in an IPv4 database.</p>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>This code requires Python 2.6+ or 3.3+. The C extension requires CPython. The
pure Python implementation has been tested with PyPy.</p>
<p>On Python 2, the <a class="reference external" href="https://pypi.python.org/pypi/ipaddress">ipaddress module</a> is
required.</p>
</div>
<div class="section" id="versioning">
<h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline">¶</a></h2>
<p>The MaxMind DB Python module uses <a class="reference external" href="http://semver.org/">Semantic Versioning</a>.</p>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
<p>Please report all issues with this code using the <a class="reference external" href="https://github.com/maxmind/MaxMind-DB-Reader-python/issues">GitHub issue tracker</a></p>
<p>If you are having an issue with a MaxMind service that is not specific to this
API, please contact <a class="reference external" href="http://www.maxmind.com/en/support">MaxMind support</a> for
assistance.</p>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body"><ol class="first loweralpha simple" start="3">
<li>2014 by MaxMind, Inc.</li>
</ol>
</td>
</tr>
<tr class="field-even field"><th class="field-name">license:</th><td class="field-body"><p class="first last">Apache License, Version 2.0</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="#">maxminddb 1.2.3 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, MaxMind, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>
|