diff options
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/index.html b/index.html new file mode 100644 index 0000000..0286b53 --- /dev/null +++ b/index.html @@ -0,0 +1,257 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Welcome to alphanum’s documentation! — alphanum 0.2.0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script src="_static/jquery.js"></script> + <script src="_static/underscore.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/language_data.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="alphanum" href="source/modules.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="#" class="icon icon-home" alt="Documentation Home"> alphanum + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="source/modules.html">alphanum</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="#">alphanum</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="#" class="icon icon-home"></a> »</li> + + <li>Welcome to alphanum’s documentation!</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="welcome-to-alphanum-s-documentation"> +<h1>Welcome to alphanum’s documentation!<a class="headerlink" href="#welcome-to-alphanum-s-documentation" title="Permalink to this headline">¶</a></h1> +</div> +<div class="section" id="alphanum"> +<h1>alphanum<a class="headerlink" href="#alphanum" title="Permalink to this headline">¶</a></h1> +<p>Simple Python library to generate pseudo-random alphanumeric strings of +arbitrary length. Requires Python 3.5+.</p> +<div class="section" id="installation"> +<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2> +<p>alphanum can be obtained from PyPI with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">alphanum</span></code>.</p> +<p>Alternatively, build it with <a class="reference external" href="https://python-poetry.org/">Poetry</a>:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install poetry +git clone https://github.com/clpo13/alphanum +<span class="nb">cd</span> alphanum +poetry build +pip install dist/alphanum-x.y.z-py3-none-any.whl +</pre></div> +</div> +</div> +<div class="section" id="usage"> +<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">alphanum</span> + +<span class="n">foo</span> <span class="o">=</span> <span class="n">alphanum</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> +<span class="nb">print</span><span class="p">(</span><span class="n">foo</span><span class="p">)</span> +</pre></div> +</div> +</div> +<div class="section" id="license"> +<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2> +<p>Copyright (c) 2020 Cody Logan. MIT licensed.</p> +<div class="toctree-wrapper compound"> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="source/modules.html">alphanum</a><ul> +<li class="toctree-l2"><a class="reference internal" href="source/alphanum.html">alphanum package</a></li> +</ul> +</li> +</ul> +</div> +</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><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> +<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> +<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> +</ul> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="source/modules.html" class="btn btn-neutral float-right" title="alphanum" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + + © Copyright 2020, Cody Logan + + </p> + </div> + + + + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file |