mirror of
https://github.com/dh1tw/pyhamtools.git
synced 2026-01-01 06:10:05 +01:00
small fixes in documentation
This commit is contained in:
parent
3f365b090f
commit
0fabb0c90b
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/lookuplib.doctree
vendored
BIN
docs/build/doctrees/lookuplib.doctree
vendored
Binary file not shown.
41
docs/build/html/lookuplib.html
vendored
41
docs/build/html/lookuplib.html
vendored
|
|
@ -123,22 +123,23 @@ instance of Redis, as well the python Redis connector (pip install redis-py).</p
|
|||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Now let’s create an instance of LookupLib, using Redis to query the data
|
||||
>>> from pyhamtools import LookupLib
|
||||
>>> import redis
|
||||
>>> r = redis.Redis()
|
||||
>>> my_lookuplib = LookupLib(lookuptype=”countryfile”, redis_instance=r, redis_prefix=”CF”)
|
||||
>>> my_lookuplib.lookup_callsign(“3D2RI”)
|
||||
{</p>
|
||||
<blockquote>
|
||||
<div>u’adif’: 460,
|
||||
u’continent’: ‘OC’,
|
||||
u’country’: ‘Rotuma Island’,
|
||||
u’cqz’: 32,
|
||||
u’ituz’: 56,
|
||||
u’latitude’: -12.48,
|
||||
u’longitude’: -177.08</div></blockquote>
|
||||
<p>}</p>
|
||||
<p>Now let’s create an instance of LookupLib, using Redis to query the data</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pyhamtools</span> <span class="kn">import</span> <span class="n">LookupLib</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">redis</span>
|
||||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">my_lookuplib</span> <span class="o">=</span> <span class="n">LookupLib</span><span class="p">(</span><span class="n">lookuptype</span><span class="o">=</span><span class="s">"countryfile"</span><span class="p">,</span> <span class="n">redis_instance</span><span class="o">=</span><span class="n">r</span><span class="p">,</span> <span class="n">redis_prefix</span><span class="o">=</span><span class="s">"CF"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">my_lookuplib</span><span class="o">.</span><span class="n">lookup_callsign</span><span class="p">(</span><span class="s">"3D2RI"</span><span class="p">)</span>
|
||||
<span class="go">{</span>
|
||||
<span class="go"> u'adif': 460,</span>
|
||||
<span class="go"> u'continent': 'OC',</span>
|
||||
<span class="go"> u'country': 'Rotuma Island',</span>
|
||||
<span class="go"> u'cqz': 32,</span>
|
||||
<span class="go"> u'ituz': 56,</span>
|
||||
<span class="go"> u'latitude': -12.48,</span>
|
||||
<span class="go"> u'longitude': -177.08</span>
|
||||
<span class="go">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p>This method is available for the following lookup type</p>
|
||||
|
|
@ -151,7 +152,7 @@ u’longitude’: -177.08</div></blockquote>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="pyhamtools.lookuplib.LookupLib.is_invalid_operation">
|
||||
<tt class="descname">is_invalid_operation</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>26185</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.is_invalid_operation" title="Permalink to this definition">¶</a></dt>
|
||||
<tt class="descname">is_invalid_operation</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719586</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.is_invalid_operation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns True if an operations is known as invalid</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -207,7 +208,7 @@ API Key for Clublog missing or incorrect</li>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="pyhamtools.lookuplib.LookupLib.lookup_callsign">
|
||||
<tt class="descname">lookup_callsign</tt><big>(</big><em>callsign=None</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>26163</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_callsign" title="Permalink to this definition">¶</a></dt>
|
||||
<tt class="descname">lookup_callsign</tt><big>(</big><em>callsign=None</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719553</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_callsign" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns lookup data if an exception exists for a callsign</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -313,7 +314,7 @@ the id 273.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="pyhamtools.lookuplib.LookupLib.lookup_prefix">
|
||||
<tt class="descname">lookup_prefix</tt><big>(</big><em>prefix</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>26163</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_prefix" title="Permalink to this definition">¶</a></dt>
|
||||
<tt class="descname">lookup_prefix</tt><big>(</big><em>prefix</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719553</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_prefix" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns lookup data of a Prefix</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -371,7 +372,7 @@ database (default database).</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="pyhamtools.lookuplib.LookupLib.lookup_zone_exception">
|
||||
<tt class="descname">lookup_zone_exception</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>12</em>, <em>7</em>, <em>26192</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_zone_exception" title="Permalink to this definition">¶</a></dt>
|
||||
<tt class="descname">lookup_zone_exception</tt><big>(</big><em>callsign</em>, <em>timestamp=datetime.datetime(2014</em>, <em>6</em>, <em>15</em>, <em>8</em>, <em>30</em>, <em>46</em>, <em>719594</em>, <em>tzinfo=<UTC>)</em><big>)</big><a class="headerlink" href="#pyhamtools.lookuplib.LookupLib.lookup_zone_exception" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a CQ Zone if an exception exists for the given callsign</p>
|
||||
<p>Args:
|
||||
callsign (string): Amateur radio callsign
|
||||
|
|
|
|||
BIN
docs/build/html/objects.inv
vendored
BIN
docs/build/html/objects.inv
vendored
Binary file not shown.
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
|
|
@ -127,6 +127,7 @@ class LookupLib(object):
|
|||
True
|
||||
|
||||
Now let's create an instance of LookupLib, using Redis to query the data
|
||||
|
||||
>>> from pyhamtools import LookupLib
|
||||
>>> import redis
|
||||
>>> r = redis.Redis()
|
||||
|
|
|
|||
Loading…
Reference in a new issue