| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419 | 
							- <!doctype html>
 
- <html lang="en">
 
- <head>
 
- <meta charset="utf-8">
 
- <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
 
- <meta name="generator" content="pdoc3 0.11.6">
 
- <title>source.apikey API documentation</title>
 
- <meta name="description" content="">
 
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
 
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
 
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
 
- <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 
- <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
 
- <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 
- <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
 
- <script>window.addEventListener('DOMContentLoaded', () => {
 
- hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
 
- hljs.highlightAll();
 
- /* Collapse source docstrings */
 
- setTimeout(() => {
 
- [...document.querySelectorAll('.hljs.language-python > .hljs-string')]
 
- .filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
 
- .forEach(el => {
 
- let d = document.createElement('details');
 
- d.classList.add('hljs-string');
 
- d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
 
- el.replaceWith(d);
 
- });
 
- }, 100);
 
- })</script>
 
- </head>
 
- <body>
 
- <main>
 
- <article id="content">
 
- <header>
 
- <h1 class="title">Module <code>source.apikey</code></h1>
 
- </header>
 
- <section id="section-intro">
 
- </section>
 
- <section>
 
- </section>
 
- <section>
 
- </section>
 
- <section>
 
- </section>
 
- <section>
 
- <h2 class="section-title" id="header-classes">Classes</h2>
 
- <dl>
 
- <dt id="source.apikey.apikey"><code class="flex name class">
 
- <span>class <span class="ident">apikey</span></span>
 
- <span>(</span><span>content: str)</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">class apikey:
 
-     """
 
-     This class represents API key, and it is also creating new apikeys from 
 
-     device random numbers generator.
 
-     Methods
 
-     ------
 
-     get_raw_size() : int
 
-         Return size of bytes which was loaded from device random number 
 
-         generator.
 
-     get_size() : int
 
-         Return lenght of the API key as string.
 
-     get_prefix() : str
 
-         Return prefix of the API keys.
 
-     create() : apikey
 
-         Create new random API key.
 
-     export() : str
 
-         Export API key as string.
 
-     """
 
-     def __init__(self, content: str) -> None:
 
-         """
 
-         It recreate API key object from key, which was previously exported
 
-         to string.
 
-         Raises
 
-         ------
 
-         ValueError
 
-             When API key lenght is not correct.
 
-         Parameters
 
-         ---------
 
-         content : str
 
-             Preiviously exported API key string.
 
-         """
 
-         
 
-         if len(content) != self.get_size():
 
-             raise ValueError("API key lenght is not correct.")
 
-         self.__content = content
 
-     def get_raw_size(self: object | None = None) -> int:
 
-         """
 
-         It return lenght of the random bytes in the API key.
 
-         Returns
 
-         -------
 
-         int
 
-             Lenght of the random bytes in the API key.
 
-         """
 
-         return 128
 
-     def get_size(self: object | None = None) -> int:
 
-         """
 
-         It return lenght of the API key string, with prefix and random bytes
 
-         converted to the hex string.
 
-         Returns
 
-         -------
 
-         int
 
-             Lenght of the API key string.
 
-         """
 
-         return len(apikey.get_prefix()) + apikey.get_raw_size() * 2
 
-     def get_prefix(self: object | None = None) -> str:
 
-         """
 
-         It return API key prefix.
 
-         Returns
 
-         -------
 
-         str
 
-             Prefix for the API key.
 
-         """
 
-         return "cxtk_"
 
-     def create() -> object:
 
-         """
 
-         It create new API key from random number generator device.
 
-         Returns
 
-         -------
 
-         apikey
 
-             New random API key.
 
-         """
 
-         raw = os.urandom(apikey.get_raw_size())
 
-         key = apikey.get_prefix() + raw.hex()
 
-         return apikey(key)
 
-     def export(self) -> str:
 
-         """
 
-         It export API key as string.
 
-         Returns
 
-         -------
 
-         str
 
-             API key string content.
 
-         """
 
-         return self.__content
 
-     def __repr__(self) -> str:
 
-         """
 
-         It return readable API key description (first 32 letters).
 
-         Returns
 
-         -------
 
-         str
 
-             Readable API key description.
 
-         """
 
-         return "API key: \"" + self.__content[0:32] + "...\""
 
-     def __str__(self) -> str:
 
-         """
 
-         It return API key string content.
 
-         Returns
 
-         -------
 
-         str
 
-             API key as string.
 
-         """
 
-         return self.__content
 
-     def __eq__(self, other) -> bool:
 
-         """
 
-         It check that API keys are same.
 
-         Returns
 
-         -------
 
-         bool  
 
-             True when API keys are same.
 
-         """
 
-         return self.__content == other.__content
 
-     def __ne__(self, other) -> bool:
 
-         """
 
-         It check that API keys are not same.
 
-         Returns 
 
-         -------
 
-         bool
 
-             True when API keys are not same.
 
-         """
 
-         return self.__content != other.__content</code></pre>
 
- </details>
 
- <div class="desc"><p>This class represents API key, and it is also creating new apikeys from
 
- device random numbers generator.</p>
 
- <h2 id="methods">Methods</h2>
 
- <p>get_raw_size() : int
 
- Return size of bytes which was loaded from device random number
 
- generator.</p>
 
- <p>get_size() : int
 
- Return lenght of the API key as string.</p>
 
- <p>get_prefix() : str
 
- Return prefix of the API keys.</p>
 
- <p>create() : apikey
 
- Create new random API key.</p>
 
- <p>export() : str
 
- Export API key as string.</p>
 
- <p>It recreate API key object from key, which was previously exported
 
- to string.</p>
 
- <h2 id="raises">Raises</h2>
 
- <dl>
 
- <dt><code>ValueError</code></dt>
 
- <dd>When API key lenght is not correct.</dd>
 
- </dl>
 
- <h2 id="parameters">Parameters</h2>
 
- <dl>
 
- <dt><strong><code>content</code></strong> : <code>str</code></dt>
 
- <dd>Preiviously exported API key string.</dd>
 
- </dl></div>
 
- <h3>Methods</h3>
 
- <dl>
 
- <dt id="source.apikey.apikey.create"><code class="name flex">
 
- <span>def <span class="ident">create</span></span>(<span>) ‑> object</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">def create() -> object:
 
-     """
 
-     It create new API key from random number generator device.
 
-     Returns
 
-     -------
 
-     apikey
 
-         New random API key.
 
-     """
 
-     raw = os.urandom(apikey.get_raw_size())
 
-     key = apikey.get_prefix() + raw.hex()
 
-     return apikey(key)</code></pre>
 
- </details>
 
- <div class="desc"><p>It create new API key from random number generator device.</p>
 
- <h2 id="returns">Returns</h2>
 
- <dl>
 
- <dt><code><a title="source.apikey.apikey" href="#source.apikey.apikey">apikey</a></code></dt>
 
- <dd>New random API key.</dd>
 
- </dl></div>
 
- </dd>
 
- <dt id="source.apikey.apikey.export"><code class="name flex">
 
- <span>def <span class="ident">export</span></span>(<span>self) ‑> str</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">def export(self) -> str:
 
-     """
 
-     It export API key as string.
 
-     Returns
 
-     -------
 
-     str
 
-         API key string content.
 
-     """
 
-     return self.__content</code></pre>
 
- </details>
 
- <div class="desc"><p>It export API key as string.</p>
 
- <h2 id="returns">Returns</h2>
 
- <dl>
 
- <dt><code>str</code></dt>
 
- <dd>API key string content.</dd>
 
- </dl></div>
 
- </dd>
 
- <dt id="source.apikey.apikey.get_prefix"><code class="name flex">
 
- <span>def <span class="ident">get_prefix</span></span>(<span>self: object | None = None) ‑> str</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">def get_prefix(self: object | None = None) -> str:
 
-     """
 
-     It return API key prefix.
 
-     Returns
 
-     -------
 
-     str
 
-         Prefix for the API key.
 
-     """
 
-     return "cxtk_"</code></pre>
 
- </details>
 
- <div class="desc"><p>It return API key prefix.</p>
 
- <h2 id="returns">Returns</h2>
 
- <dl>
 
- <dt><code>str</code></dt>
 
- <dd>Prefix for the API key.</dd>
 
- </dl></div>
 
- </dd>
 
- <dt id="source.apikey.apikey.get_raw_size"><code class="name flex">
 
- <span>def <span class="ident">get_raw_size</span></span>(<span>self: object | None = None) ‑> int</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">def get_raw_size(self: object | None = None) -> int:
 
-     """
 
-     It return lenght of the random bytes in the API key.
 
-     Returns
 
-     -------
 
-     int
 
-         Lenght of the random bytes in the API key.
 
-     """
 
-     return 128</code></pre>
 
- </details>
 
- <div class="desc"><p>It return lenght of the random bytes in the API key.</p>
 
- <h2 id="returns">Returns</h2>
 
- <dl>
 
- <dt><code>int</code></dt>
 
- <dd>Lenght of the random bytes in the API key.</dd>
 
- </dl></div>
 
- </dd>
 
- <dt id="source.apikey.apikey.get_size"><code class="name flex">
 
- <span>def <span class="ident">get_size</span></span>(<span>self: object | None = None) ‑> int</span>
 
- </code></dt>
 
- <dd>
 
- <details class="source">
 
- <summary>
 
- <span>Expand source code</span>
 
- </summary>
 
- <pre><code class="python">def get_size(self: object | None = None) -> int:
 
-     """
 
-     It return lenght of the API key string, with prefix and random bytes
 
-     converted to the hex string.
 
-     Returns
 
-     -------
 
-     int
 
-         Lenght of the API key string.
 
-     """
 
-     return len(apikey.get_prefix()) + apikey.get_raw_size() * 2</code></pre>
 
- </details>
 
- <div class="desc"><p>It return lenght of the API key string, with prefix and random bytes
 
- converted to the hex string.</p>
 
- <h2 id="returns">Returns</h2>
 
- <dl>
 
- <dt><code>int</code></dt>
 
- <dd>Lenght of the API key string.</dd>
 
- </dl></div>
 
- </dd>
 
- </dl>
 
- </dd>
 
- </dl>
 
- </section>
 
- </article>
 
- <nav id="sidebar">
 
- <div class="toc">
 
- <ul></ul>
 
- </div>
 
- <ul id="index">
 
- <li><h3>Super-module</h3>
 
- <ul>
 
- <li><code><a title="source" href="index.html">source</a></code></li>
 
- </ul>
 
- </li>
 
- <li><h3><a href="#header-classes">Classes</a></h3>
 
- <ul>
 
- <li>
 
- <h4><code><a title="source.apikey.apikey" href="#source.apikey.apikey">apikey</a></code></h4>
 
- <ul class="">
 
- <li><code><a title="source.apikey.apikey.create" href="#source.apikey.apikey.create">create</a></code></li>
 
- <li><code><a title="source.apikey.apikey.export" href="#source.apikey.apikey.export">export</a></code></li>
 
- <li><code><a title="source.apikey.apikey.get_prefix" href="#source.apikey.apikey.get_prefix">get_prefix</a></code></li>
 
- <li><code><a title="source.apikey.apikey.get_raw_size" href="#source.apikey.apikey.get_raw_size">get_raw_size</a></code></li>
 
- <li><code><a title="source.apikey.apikey.get_size" href="#source.apikey.apikey.get_size">get_size</a></code></li>
 
- </ul>
 
- </li>
 
- </ul>
 
- </li>
 
- </ul>
 
- </nav>
 
- </main>
 
- <footer id="footer">
 
- <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
 
- </footer>
 
- </body>
 
- </html>
 
 
  |