Browse Source

Updated Docs

bernhardbuhl 4 years ago
parent
commit
4069c72409

+ 8 - 0
docs/Developer.rst

@@ -85,3 +85,11 @@ Building Executables
 * ``git add .`` in the folder ``baangt-executables``
 * ``git commit -m <version>``
 * ``git push``
+
+Windows bundle executables:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Install innosetup-qsp (QuickStartPack) Versoin 6 from https://jrsoftware.org/isdl.php
+* Open Inno Setup
+* Use Script ``/windows/baangtSetupWindows.iss``
+

BIN
docs/_build/doctrees/Developer.doctree


BIN
docs/_build/doctrees/changelog.doctree


BIN
docs/_build/doctrees/environment.pickle


BIN
docs/_build/doctrees/simpleExample.doctree


+ 36 - 1
docs/_build/html/Developer.html

@@ -95,6 +95,11 @@
 <li class="toctree-l2"><a class="reference internal" href="#debugging">Debugging</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#plugins">Plugins</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#network-trace">Network trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#building-baangt-sources">Building baangt sources</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#building-pypi">Building pyPi</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#building-executables">Building Executables</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="HistoryAndReasons.html">   History</a></li>
@@ -102,7 +107,7 @@
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">   Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="PlannedFeatures.html">   Planned Features</a></li>
 <li class="toctree-l1"><a class="reference internal" href="BrowserDrivers.html">   Browser Drivers</a></li>
-<li class="toctree-l1"><a class="reference internal" href="articles/Articles.html">:subheader: Articles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="articles/Articles.html">   :subheader: Articles</a></li>
 <li class="toctree-l1"><a class="reference external" href="http://www.baangt.org">   Web</a></li>
 </ul>
 
@@ -223,6 +228,36 @@ In the output file you’ll see a new tab “Network” that shows all calls, he
 call.</p>
 <p>Use with care, as the file can get pretty big.</p>
 </div>
+<div class="section" id="building-baangt-sources">
+<h2>Building baangt sources<a class="headerlink" href="#building-baangt-sources" title="Permalink to this headline">¶</a></h2>
+<p>Core project members can build distribution as follows:</p>
+<div class="section" id="building-pypi">
+<h3>Building pyPi<a class="headerlink" href="#building-pypi" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li><p>Increase version in <code class="docutils literal notranslate"><span class="pre">setup.py</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">MakePackage.sh</span></code> to upload to PyPi</p></li>
+<li><p>Use latest version in depending project’s <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> (Custom projects)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p></li>
+</ul>
+</div>
+<div class="section" id="building-executables">
+<h3>Building Executables<a class="headerlink" href="#building-executables" title="Permalink to this headline">¶</a></h3>
+<ul>
+<li><p>Checkout <code class="docutils literal notranslate"><span class="pre">https://github.com/Athos1972/baangt-executables</span></code></p></li>
+<li><p>On a Windows computer: <code class="docutils literal notranslate"><span class="pre">execWindow.bat</span></code></p></li>
+<li><p>Move <code class="docutils literal notranslate"><span class="pre">/executables/baangt_windows_executable.zip</span></code> to checked out <code class="docutils literal notranslate"><span class="pre">baangt-executables</span></code> ideally with this line:</p>
+<blockquote>
+<div><p><code class="docutils literal notranslate"><span class="pre">mv</span> <span class="pre">executables/baangt_mac_executable.zip</span> <span class="pre">../baangt-executables</span></code></p>
+</div></blockquote>
+</li>
+<li><p>Repeat accordingly on Mac (<code class="docutils literal notranslate"><span class="pre">execMac.sh</span></code>)</p></li>
+<li><p>Repeat accordingly on Ubuntu (<code class="docutils literal notranslate"><span class="pre">execUbuntu.sh</span></code>)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">add</span> <span class="pre">.</span></code> in the folder <code class="docutils literal notranslate"><span class="pre">baangt-executables</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-m</span> <span class="pre">&lt;version&gt;</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span></code></p></li>
+</ul>
+</div>
+</div>
 </div>
 
 

+ 27 - 1
docs/_build/html/_sources/Developer.rst.txt

@@ -58,4 +58,30 @@ the calls that the browser exchanges with the backend. If you need this, use ``T
 In the output file you'll see a new tab "Network" that shows all calls, headers, payload and timing information for each
 call.
 
-Use with care, as the file can get pretty big.
+Use with care, as the file can get pretty big.
+
+Building baangt sources
+-----------------------
+Core project members can build distribution as follows:
+
+Building pyPi
+^^^^^^^^^^^^^
+
+* Increase version in ``setup.py``
+* ``MakePackage.sh`` to upload to PyPi
+* Use latest version in depending project's ``requirements.txt`` (Custom projects)
+* ``pip install -r requirements.txt``
+
+Building Executables
+^^^^^^^^^^^^^^^^^^^^
+
+* Checkout ``https://github.com/Athos1972/baangt-executables``
+* On a Windows computer: ``execWindow.bat``
+* Move ``/executables/baangt_windows_executable.zip`` to checked out ``baangt-executables`` ideally with this line:
+
+    ``mv executables/baangt_mac_executable.zip ../baangt-executables``
+* Repeat accordingly on Mac (``execMac.sh``)
+* Repeat accordingly on Ubuntu (``execUbuntu.sh``)
+* ``git add .`` in the folder ``baangt-executables``
+* ``git commit -m <version>``
+* ``git push``

+ 14 - 0
docs/_build/html/_sources/changelog.rst.txt

@@ -1,6 +1,20 @@
 Change log
 ==========
 
+2020.04
+^^^^^^^
+
+Summary:
+
+New features
+++++++++++++
+* SimpleFormat: New short command ``iban`` will create a random IBAN. Powered by Schwifty library.
+
+Changes
++++++++
+* Chrome now as default browser as many people don't have Firefox
+* Improved browserDriver Download for executables (didn't work in some cases)
+
 2020.03
 ^^^^^^^
 Summary: Release Candiate 3 is on the road!

+ 5 - 0
docs/_build/html/_sources/simpleExample.rst.txt

@@ -223,6 +223,11 @@ More details on Activities
 
    * - pause
      - Will pause for the number of secons in ``value``. Valid numbers are float, e.g. 2, 0.2, 0.1, 25
+   * - iban
+     - Will create a random IBAN account number. ``value 2`` is the destination field of the test case structure. If you
+       don't provide a field name (not necessarily one that exists in the input file. Can be any field name!) nothing will
+       happen. If you provide input parameters in column ``value`` (``SWIFT`` and/or ``COUNTRY``) the IBAN will be created for that bank-code
+       and/or country.
    * - address_create
      - provide an easy and easily extendable way to generate address data for a test case
        The following fields variable are stored in testcaseDataDict:

File diff suppressed because it is too large
+ 31 - 9
docs/_build/html/changelog.html


+ 5 - 3
docs/_build/html/index.html

@@ -222,6 +222,7 @@ and well documented master functionality.</p>
 <li class="toctree-l2"><a class="reference internal" href="Developer.html#debugging">Debugging</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Developer.html#plugins">Plugins</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Developer.html#network-trace">Network trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Developer.html#building-baangt-sources">Building baangt sources</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="HistoryAndReasons.html">   History</a><ul>
@@ -236,9 +237,10 @@ and well documented master functionality.</p>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">   Changelog</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">2020.03</a></li>
-<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">2020.02</a></li>
-<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">2020.01</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">2020.04</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">2020.03</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">2020.02</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">2020.01</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="PlannedFeatures.html">   Planned Features</a><ul>

File diff suppressed because it is too large
+ 1 - 1
docs/_build/html/searchindex.js


+ 7 - 1
docs/_build/html/simpleExample.html

@@ -438,7 +438,13 @@ want conditional execution of a larger block of statements depending on an eleme
 <tr class="row-even"><td><p>pause</p></td>
 <td><p>Will pause for the number of secons in <code class="docutils literal notranslate"><span class="pre">value</span></code>. Valid numbers are float, e.g. 2, 0.2, 0.1, 25</p></td>
 </tr>
-<tr class="row-odd"><td><p>address_create</p></td>
+<tr class="row-odd"><td><p>iban</p></td>
+<td><p>Will create a random IBAN account number. <code class="docutils literal notranslate"><span class="pre">value</span> <span class="pre">2</span></code> is the destination field of the test case structure. If you
+don’t provide a field name (not necessarily one that exists in the input file. Can be any field name!) nothing will
+happen. If you provide input parameters in column <code class="docutils literal notranslate"><span class="pre">value</span></code> (<code class="docutils literal notranslate"><span class="pre">SWIFT</span></code> and/or <code class="docutils literal notranslate"><span class="pre">COUNTRY</span></code>) the IBAN will be created for that bank-code
+and/or country.</p></td>
+</tr>
+<tr class="row-even"><td><p>address_create</p></td>
 <td><p>provide an easy and easily extendable way to generate address data for a test case
 The following fields variable are stored in testcaseDataDict:</p>
 <p>CountryCode