📚 Added the content of the document 'index.html'

iwasakishuto · May 11, 2021 · 2af9222 · 2af9222
1 parent 5c1014a
commit 2af9222
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 20 deletions.
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -24,19 +24,83 @@ A collection of useful python programs.
 Installation
 ------------
 
-There are two ways to install **Python-Charmers**:
+1. Install **``Python-Charmers``** (There are two ways to install):
 
-* **Install Python-Charmers from PyPI (recommended):**
-   ::
+   -  Create an environment for Python-Charmers using `Pyenv <https://github.com/pyenv/pyenv>`__ and `Poetry <https://python-poetry.org/>`__ **(recommended)**
+      ::
+
+         $ pyenv install 3.8.9
+         $ pyenv local 3.8.9
+         $ python -V
+         Python 3.8.9
+         $ poetry install
+
+   -  Install in a specific environment
+
+      -  Install from PyPI:
+         ::
+
+            $ sudo pip install Python-Charmers
 
-       $ sudo pip install Python-Charmers
+      -  Alternatively: install PyGuitar from the GitHub source:
+         ::
+            
+            $ git clone https://github.com/iwasakishuto/Python-Charmers.git
+            # If you want to use the latest version (under development)
+            $ git clone -b develop https://github.com/iwasakishuto/Python-Charmers.git
+            $ cd Python-Charmers
+            $ sudo python setup.py install
 
-* **Alternatively: install Python-Charmers from the GitHub source:**
+2. Install **driver** for ``selenium`` . ``Selenium`` requires a driver to interface with the chosen browser, so please visit the `documentation <https://selenium-python.readthedocs.io/installation.html#drivers>`__ to install it.
    ::
 
-       $ git clone https://github.com/iwasakishuto/Python-Charmers.git
-       $ cd Python-Charmers
-       $ sudo python setup.py install
+      # Example: Chrome
+      # visit "chrome://settings/help" to check your chrome version.     
+      # visit "https://chromedriver.chromium.org/downloads" to check <Suitable.Driver.Version> for your chrome.     
+      $ wget https://chromedriver.storage.googleapis.com/<Suitable.Driver.Version>/chromedriver_mac64.zip     
+      $ unzip chromedriver_mac64.zip     
+      $ mv chromedriver /usr/local/bin/chromedriver     
+      $ chmod +x /usr/local/bin/chromedriver
+
+CLI
+---
+
+**CLI** is a command line program that accepts text input to execute operating system functions.
+
++---------------------+------------------------------------------------------------------------------+
+|       command       |                                 description                                  |
++=====================+==============================================================================+
+|            book2img | Convert Book into Sequential Images.                                         |
++---------------------+------------------------------------------------------------------------------+
+|         cv-cascades | Control the OpenCV cascade Examples.                                         |
++---------------------+------------------------------------------------------------------------------+
+|    cv-paper-scanner | Paper Scanner using OpenCV.                                                  |
++---------------------+------------------------------------------------------------------------------+
+|    cv-pencil-sketch | Convert the image like a pencil drawing.                                     |
++---------------------+------------------------------------------------------------------------------+
+|           cv-window | Use :meth:`cvWindow <pycharmers.opencv.windows.cvWindow>` to control frames. |
++---------------------+------------------------------------------------------------------------------+
+|          lyricVideo | Create a lyric Video.                                                        |
++---------------------+------------------------------------------------------------------------------+
+|   form-auto-fill-in | Auto fill in your form using your saved information (or answer on the spot). |
++---------------------+------------------------------------------------------------------------------+
+|         openBrowser | Display url using the default browser.                                       |
++---------------------+------------------------------------------------------------------------------+
+|             pdfmine | Analyze PDF and extract various elements.                                    |
++---------------------+------------------------------------------------------------------------------+
+|  regexp-replacement | String replacement in a file using regular expression                        |
++---------------------+------------------------------------------------------------------------------+
+|     render-template | Render templates.                                                            |
++---------------------+------------------------------------------------------------------------------+
+| requirements-create | Create a ``requirements.text``                                               |
++---------------------+------------------------------------------------------------------------------+
+|     pycharmers-show | Show all Python-Charmers's command line programs.                            |
++---------------------+------------------------------------------------------------------------------+
+|            tweetile | Divide one image into three so that you can tweet beautifully.               |
++---------------------+------------------------------------------------------------------------------+
+|           video2gif | Convert Video into Gif.                                                      |
++---------------------+------------------------------------------------------------------------------+
+
 
 Contents
 --------

diff --git a/docs/index.html b/docs/index.html
@@ -8,7 +8,7 @@
   <meta property="og:title" content="Welcome to Python-Charmers’s documentation!" />
   <meta property="og:type" content="article" />
   <meta property="og:url" content="https://iwasakishuto.github.io/Python-Charmers/index.html" />
-  <meta property="og:description" content="header PyPI version GitHub version Python package Upload Python Package license A collection of useful python programs. Installation: There are two ways to install Python-Charmers:- Install Python-..." />
+  <meta property="og:description" content="header PyPI version GitHub version Python package Upload Python Package license A collection of useful python programs. Installation: Install``Python-Charmers``(There are two ways to install):- Cre..." />
   <meta property="og:image" content="https://iwasakishuto.github.io/images/FacebookImage/Python-Charmers.png" />
   <meta property="og:site_name" content="Python-Charmers" />
 <meta name="twitter:site" content="@cabernet_rock" />
@@ -66,25 +66,112 @@ <h1>Welcome to Python-Charmers’s documentation!<a class="headerlink" href="#we
 <p>A collection of useful python programs.</p>
 <div class="section" id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
-<p>There are two ways to install <strong>Python-Charmers</strong>:</p>
+<ol class="arabic">
+<li><p>Install <strong>``Python-Charmers``</strong> (There are two ways to install):</p>
 <ul>
-<li><dl>
-<dt><strong>Install Python-Charmers from PyPI (recommended):</strong></dt><dd><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install Python-Charmers
+<li><p>Create an environment for Python-Charmers using <a class="reference external" href="https://github.com/pyenv/pyenv">Pyenv</a> and <a class="reference external" href="https://python-poetry.org/">Poetry</a> <strong>(recommended)</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pyenv install 3.8.9
+$ pyenv local 3.8.9
+$ python -V
+Python 3.8.9
+$ poetry install
 </pre></div>
 </div>
-</dd>
-</dl>
 </li>
-<li><dl>
-<dt><strong>Alternatively: install Python-Charmers from the GitHub source:</strong></dt><dd><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/iwasakishuto/Python-Charmers.git
+<li><p>Install in a specific environment</p>
+<ul>
+<li><p>Install from PyPI:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install Python-Charmers
+</pre></div>
+</div>
+</li>
+<li><p>Alternatively: install PyGuitar from the GitHub source:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/iwasakishuto/Python-Charmers.git
+# If you want to use the latest version (under development)
+$ git clone -b develop https://github.com/iwasakishuto/Python-Charmers.git
 $ cd Python-Charmers
 $ sudo python setup.py install
 </pre></div>
 </div>
-</dd>
-</dl>
 </li>
 </ul>
+</li>
+</ul>
+</li>
+<li><p>Install <strong>driver</strong> for <code class="docutils literal notranslate"><span class="pre">selenium</span></code> . <code class="docutils literal notranslate"><span class="pre">Selenium</span></code> requires a driver to interface with the chosen browser, so please visit the <a class="reference external" href="https://selenium-python.readthedocs.io/installation.html#drivers">documentation</a> to install it.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Example: Chrome
+# visit &quot;chrome://settings/help&quot; to check your chrome version.
+# visit &quot;https://chromedriver.chromium.org/downloads&quot; to check &lt;Suitable.Driver.Version&gt; for your chrome.
+$ wget https://chromedriver.storage.googleapis.com/&lt;Suitable.Driver.Version&gt;/chromedriver_mac64.zip
+$ unzip chromedriver_mac64.zip
+$ mv chromedriver /usr/local/bin/chromedriver
+$ chmod +x /usr/local/bin/chromedriver
+</pre></div>
+</div>
+</li>
+</ol>
+</div>
+<div class="section" id="cli">
+<h2>CLI<a class="headerlink" href="#cli" title="Permalink to this headline">¶</a></h2>
+<p><strong>CLI</strong> is a command line program that accepts text input to execute operating system functions.</p>
+<table class="docutils align-default">
+<colgroup>
+<col style="width: 21%" />
+<col style="width: 79%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>command</p></th>
+<th class="head"><p>description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>book2img</p></td>
+<td><p>Convert Book into Sequential Images.</p></td>
+</tr>
+<tr class="row-odd"><td><p>cv-cascades</p></td>
+<td><p>Control the OpenCV cascade Examples.</p></td>
+</tr>
+<tr class="row-even"><td><p>cv-paper-scanner</p></td>
+<td><p>Paper Scanner using OpenCV.</p></td>
+</tr>
+<tr class="row-odd"><td><p>cv-pencil-sketch</p></td>
+<td><p>Convert the image like a pencil drawing.</p></td>
+</tr>
+<tr class="row-even"><td><p>cv-window</p></td>
+<td><p>Use <a class="reference internal" href="pycharmers.opencv.windows.html#pycharmers.opencv.windows.cvWindow" title="pycharmers.opencv.windows.cvWindow"><code class="xref py py-meth docutils literal notranslate"><span class="pre">cvWindow</span></code></a> to control frames.</p></td>
+</tr>
+<tr class="row-odd"><td><p>lyricVideo</p></td>
+<td><p>Create a lyric Video.</p></td>
+</tr>
+<tr class="row-even"><td><p>form-auto-fill-in</p></td>
+<td><p>Auto fill in your form using your saved information (or answer on the spot).</p></td>
+</tr>
+<tr class="row-odd"><td><p>openBrowser</p></td>
+<td><p>Display url using the default browser.</p></td>
+</tr>
+<tr class="row-even"><td><p>pdfmine</p></td>
+<td><p>Analyze PDF and extract various elements.</p></td>
+</tr>
+<tr class="row-odd"><td><p>regexp-replacement</p></td>
+<td><p>String replacement in a file using regular expression</p></td>
+</tr>
+<tr class="row-even"><td><p>render-template</p></td>
+<td><p>Render templates.</p></td>
+</tr>
+<tr class="row-odd"><td><p>requirements-create</p></td>
+<td><p>Create a <code class="docutils literal notranslate"><span class="pre">requirements.text</span></code></p></td>
+</tr>
+<tr class="row-even"><td><p>pycharmers-show</p></td>
+<td><p>Show all Python-Charmers’s command line programs.</p></td>
+</tr>
+<tr class="row-odd"><td><p>tweetile</p></td>
+<td><p>Divide one image into three so that you can tweet beautifully.</p></td>
+</tr>
+<tr class="row-even"><td><p>video2gif</p></td>
+<td><p>Convert Video into Gif.</p></td>
+</tr>
+</tbody>
+</table>
 </div>
 <div class="section" id="contents">
 <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/pycharmers.opencv.cvui.html b/docs/pycharmers.opencv.cvui.html
@@ -76,7 +76,7 @@ <h3>Navigation</h3>
 Licensed under the <a class="reference external" href="https://github.com/Dovyski/cvui/blob/master/LICENSE.md">MIT license</a>.</p>
 <dl class="py function">
 <dt id="pycharmers.opencv.cvui.init">
-<code class="sig-prename descclassname">pycharmers.opencv.cvui.</code><code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">windowNames</span><span class="o">=</span><span class="default_value">'2021-05-11&#64;10.27.48'</span></em>, <em class="sig-param"><span class="n">numWindows</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">delayWaitKey</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">createNamedWindows</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pycharmers/opencv/cvui.html#init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pycharmers.opencv.cvui.init" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">pycharmers.opencv.cvui.</code><code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">windowNames</span><span class="o">=</span><span class="default_value">'2021-05-12&#64;00.33.06'</span></em>, <em class="sig-param"><span class="n">numWindows</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">delayWaitKey</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">createNamedWindows</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pycharmers/opencv/cvui.html#init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pycharmers.opencv.cvui.init" title="Permalink to this definition">¶</a></dt>
 <dd><p>Initialize cvui using a list of names of windows where components will be added.</p>
 <p>It is also possible to tell cvui to handle OpenCV’s event queue automatically (by informing a value greater than zero in the <cite>delayWaitKey</cite> parameter of the function).</p>
 <p>In that case, cvui will automatically call <code class="docutils literal notranslate"><span class="pre">cv2.waitKey()</span></code> within <code class="docutils literal notranslate"><span class="pre">cvui.update()</span></code> , so you don’t have to worry about it. The value passed to <cite>delayWaitKey</cite> will be used as the delay for <cite>cv2.waitKey()</cite>.</p>

diff --git a/docs/searchindex.js b/docs/searchindex.js