Skip to content

Commit 54a4dd3

Browse files
andreax79andreax79
committed
docs
1 parent fd0fab0 commit 54a4dd3

30 files changed

Lines changed: 958 additions & 27648 deletions

‎docs/_build/doctrees/environment.pickle‎

201 KB
Binary file not shown.

‎docs/_build/doctrees/index.doctree‎

2.12 KB
Binary file not shown.

‎docs/_build/html/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: c9c5c611d355f812ec594286982b1393
3+
config: d7815349536b2ccb6cec851b63c3056f
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_build/html/_modules/index.html‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
21
<!DOCTYPE html>
32

4-
<html>
3+
<html lang="en">
54
<head>
65
<meta charset="utf-8" />
76
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -10,9 +9,8 @@
109
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
1110

1211
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
13-
<script src="../_static/jquery.js"></script>
14-
<script src="../_static/underscore.js"></script>
1512
<script src="../_static/doctools.js"></script>
13+
<script src="../_static/sphinx_highlight.js"></script>
1614

1715
<link rel="index" title="Index" href="../genindex.html" />
1816
<link rel="search" title="Search" href="../search.html" />
@@ -60,7 +58,7 @@ <h3 id="searchlabel">Quick search</h3>
6058
</form>
6159
</div>
6260
</div>
63-
<script>$('#searchbox').show(0);</script>
61+
<script>document.getElementById('searchbox').style.display = "block"</script>
6462
</div>
6563
</div>
6664
<div class="clearer"></div>
@@ -79,7 +77,7 @@ <h3>Navigation</h3>
7977
</ul>
8078
</div>
8179
<div class="footer" role="contentinfo">
82-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
80+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.0.
8381
</div>
8482
</body>
8583
</html>

‎docs/_build/html/_modules/securid/exceptions.html‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
21
<!DOCTYPE html>
32

4-
<html>
3+
<html lang="en">
54
<head>
65
<meta charset="utf-8" />
76
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>securid.exceptions &#8212; securid 0.9.4 documentation</title>
7+
<title>securid.exceptions &#8212; securid 0.9.5 documentation</title>
98
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
109
<link rel="stylesheet" type="text/css" href="../../_static/classic.css" />
1110

1211
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
13-
<script src="../../_static/jquery.js"></script>
14-
<script src="../../_static/underscore.js"></script>
1512
<script src="../../_static/doctools.js"></script>
13+
<script src="../../_static/sphinx_highlight.js"></script>
1614

1715
<link rel="index" title="Index" href="../../genindex.html" />
1816
<link rel="search" title="Search" href="../../search.html" />
@@ -26,7 +24,7 @@ <h3>Navigation</h3>
2624
<li class="right" >
2725
<a href="../../py-modindex.html" title="Python Module Index"
2826
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.4 documentation</a> &#187;</li>
27+
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.5 documentation</a> &#187;</li>
3028
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3129
<li class="nav-item nav-item-this"><a href="">securid.exceptions</a></li>
3230
</ul>
@@ -50,36 +48,36 @@ <h1>Source code for securid.exceptions</h1><div class="highlight"><pre>
5048

5149

5250
<div class="viewcode-block" id="ParseException"><a class="viewcode-back" href="../../index.html#securid.exceptions.ParseException">[docs]</a><span class="k">class</span> <span class="nc">ParseException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
53-
<span class="sd">&quot;&quot;&quot;</span>
51+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
5452
<span class="sd"> This is raised in case of error parsing file</span>
5553
<span class="sd"> &quot;&quot;&quot;</span>
5654

5755
<span class="k">pass</span></div>
5856

5957

6058
<div class="viewcode-block" id="InvalidToken"><a class="viewcode-back" href="../../index.html#securid.exceptions.InvalidToken">[docs]</a><span class="k">class</span> <span class="nc">InvalidToken</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
61-
<span class="sd">&quot;&quot;&quot;</span>
59+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
6260
<span class="sd"> This is raised in case of invalid token</span>
6361
<span class="sd"> &quot;&quot;&quot;</span>
6462

6563
<span class="k">pass</span></div>
6664

6765

6866
<div class="viewcode-block" id="InvalidSignature"><a class="viewcode-back" href="../../index.html#securid.exceptions.InvalidSignature">[docs]</a><span class="k">class</span> <span class="nc">InvalidSignature</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
69-
<span class="sd">&quot;&quot;&quot;</span>
67+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
7068
<span class="sd"> This is raised when signature verification fails.</span>
7169
<span class="sd"> This can occur when password is required for decrypting the token.</span>
7270
<span class="sd"> &quot;&quot;&quot;</span></div>
7371

7472

7573
<div class="viewcode-block" id="InvalidSeed"><a class="viewcode-back" href="../../index.html#securid.exceptions.InvalidSeed">[docs]</a><span class="k">class</span> <span class="nc">InvalidSeed</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
76-
<span class="sd">&quot;&quot;&quot;</span>
74+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
7775
<span class="sd"> This is raised when the seed is missing or invalid.</span>
7876
<span class="sd"> &quot;&quot;&quot;</span></div>
7977

8078

8179
<div class="viewcode-block" id="InvalidSerial"><a class="viewcode-back" href="../../index.html#securid.exceptions.InvalidSerial">[docs]</a><span class="k">class</span> <span class="nc">InvalidSerial</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
82-
<span class="sd">&quot;&quot;&quot;</span>
80+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
8381
<span class="sd"> This is raised when the serial is missing or invalid.</span>
8482
<span class="sd"> &quot;&quot;&quot;</span></div>
8583
</pre></div>
@@ -99,7 +97,7 @@ <h3 id="searchlabel">Quick search</h3>
9997
</form>
10098
</div>
10199
</div>
102-
<script>$('#searchbox').show(0);</script>
100+
<script>document.getElementById('searchbox').style.display = "block"</script>
103101
</div>
104102
</div>
105103
<div class="clearer"></div>
@@ -113,13 +111,13 @@ <h3>Navigation</h3>
113111
<li class="right" >
114112
<a href="../../py-modindex.html" title="Python Module Index"
115113
>modules</a> |</li>
116-
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.4 documentation</a> &#187;</li>
114+
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.5 documentation</a> &#187;</li>
117115
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
118116
<li class="nav-item nav-item-this"><a href="">securid.exceptions</a></li>
119117
</ul>
120118
</div>
121119
<div class="footer" role="contentinfo">
122-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
120+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.0.
123121
</div>
124122
</body>
125123
</html>

‎docs/_build/html/_modules/securid/jsontoken.html‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
21
<!DOCTYPE html>
32

4-
<html>
3+
<html lang="en">
54
<head>
65
<meta charset="utf-8" />
76
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>securid.jsontoken &#8212; securid 0.9.4 documentation</title>
7+
<title>securid.jsontoken &#8212; securid 0.9.5 documentation</title>
98
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
109
<link rel="stylesheet" type="text/css" href="../../_static/classic.css" />
1110

1211
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
13-
<script src="../../_static/jquery.js"></script>
14-
<script src="../../_static/underscore.js"></script>
1512
<script src="../../_static/doctools.js"></script>
13+
<script src="../../_static/sphinx_highlight.js"></script>
1614

1715
<link rel="index" title="Index" href="../../genindex.html" />
1816
<link rel="search" title="Search" href="../../search.html" />
@@ -26,7 +24,7 @@ <h3>Navigation</h3>
2624
<li class="right" >
2725
<a href="../../py-modindex.html" title="Python Module Index"
2826
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.4 documentation</a> &#187;</li>
27+
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.5 documentation</a> &#187;</li>
3028
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3129
<li class="nav-item nav-item-this"><a href="">securid.jsontoken</a></li>
3230
</ul>
@@ -54,7 +52,7 @@ <h1>Source code for securid.jsontoken</h1><div class="highlight"><pre>
5452

5553

5654
<div class="viewcode-block" id="JSONTokenFile"><a class="viewcode-back" href="../../index.html#securid.jsontoken.JSONTokenFile">[docs]</a><span class="k">class</span> <span class="nc">JSONTokenFile</span><span class="p">(</span><span class="n">AbstractTokenFile</span><span class="p">):</span>
57-
<span class="sd">&quot;&quot;&quot;</span>
55+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
5856
<span class="sd"> Handler for JSON file format</span>
5957

6058
<span class="sd"> Example:</span>
@@ -82,7 +80,7 @@ <h1>Source code for securid.jsontoken</h1><div class="highlight"><pre>
8280
<span class="n">data</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">bytearray</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
8381
<span class="n">token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Token</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
8482
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
85-
<span class="sd">&quot;&quot;&quot;</span>
83+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
8684
<span class="sd"> :param filename: JSON file path</span>
8785
<span class="sd"> :param data: token as string in JSON format or as a dictionary</span>
8886
<span class="sd"> :param token: Token instance</span>
@@ -102,7 +100,7 @@ <h1>Source code for securid.jsontoken</h1><div class="highlight"><pre>
102100

103101
<div class="viewcode-block" id="JSONTokenFile.parse_file"><a class="viewcode-back" href="../../index.html#securid.jsontoken.JSONTokenFile.parse_file">[docs]</a> <span class="nd">@classmethod</span>
104102
<span class="k">def</span> <span class="nf">parse_file</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
105-
<span class="sd">&quot;&quot;&quot;</span>
103+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
106104
<span class="sd"> Parse JSON file, return content as string</span>
107105

108106
<span class="sd"> :param filename: JSON file path</span>
@@ -134,15 +132,15 @@ <h1>Source code for securid.jsontoken</h1><div class="highlight"><pre>
134132
<span class="k">raise</span> <span class="n">ParseException</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span>
135133

136134
<div class="viewcode-block" id="JSONTokenFile.get_token"><a class="viewcode-back" href="../../index.html#securid.jsontoken.JSONTokenFile.get_token">[docs]</a> <span class="k">def</span> <span class="nf">get_token</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Token</span><span class="p">:</span>
137-
<span class="sd">&quot;&quot;&quot;</span>
135+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
138136
<span class="sd"> Return the Token instance</span>
139137

140138
<span class="sd"> :param password: optional password for decrypting the token</span>
141139
<span class="sd"> &quot;&quot;&quot;</span>
142140
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span></div>
143141

144142
<div class="viewcode-block" id="JSONTokenFile.export_token"><a class="viewcode-back" href="../../index.html#securid.jsontoken.JSONTokenFile.export_token">[docs]</a> <span class="k">def</span> <span class="nf">export_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
145-
<span class="sd">&quot;&quot;&quot;</span>
143+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
146144
<span class="sd"> Export token as JSON</span>
147145
<span class="sd"> &quot;&quot;&quot;</span>
148146
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">token</span><span class="o">.</span><span class="n">seed</span><span class="p">:</span>
@@ -184,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
184182
</form>
185183
</div>
186184
</div>
187-
<script>$('#searchbox').show(0);</script>
185+
<script>document.getElementById('searchbox').style.display = "block"</script>
188186
</div>
189187
</div>
190188
<div class="clearer"></div>
@@ -198,13 +196,13 @@ <h3>Navigation</h3>
198196
<li class="right" >
199197
<a href="../../py-modindex.html" title="Python Module Index"
200198
>modules</a> |</li>
201-
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.4 documentation</a> &#187;</li>
199+
<li class="nav-item nav-item-0"><a href="../../index.html">securid 0.9.5 documentation</a> &#187;</li>
202200
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
203201
<li class="nav-item nav-item-this"><a href="">securid.jsontoken</a></li>
204202
</ul>
205203
</div>
206204
<div class="footer" role="contentinfo">
207-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
205+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.0.
208206
</div>
209207
</body>
210208
</html>

0 commit comments

Comments
 (0)