-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
new ShellTable, docs, typehings, docstrings, readme...
- Loading branch information
1 parent
cbefa00
commit 2266b59
Showing
23 changed files
with
4,515 additions
and
5,034 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| <!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="pdoc 0.10.0" /> | ||
| <title>pysapscript API documentation</title> | ||
| <meta name="description" content="Description …" /> | ||
| <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin> | ||
| <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin> | ||
| <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin> | ||
| <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;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:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 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 .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#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-weight:bold;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}.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 .5em;margin-bottom:1em}.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}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.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/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> | ||
| <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script> | ||
| </head> | ||
| <body> | ||
| <main> | ||
| <article id="content"> | ||
| <header> | ||
| <h1 class="title">Package <code>pysapscript</code></h1> | ||
| </header> | ||
| <section id="section-intro"> | ||
| <h1 id="description">Description</h1> | ||
| <p>SAP scripting for Python automatization</p> | ||
| <h1 id="documentation">Documentation</h1> | ||
| <p><a href="https://github.com/kamildemocko/PySapScript">Github - https://github.com/kamildemocko/PySapScript</a></p> | ||
| <h1 id="installation">Installation</h1> | ||
| <pre><code class="language-pip">pip install pysapscript | ||
| </code></pre> | ||
| <h1 id="usage">Usage</h1> | ||
| <h2 id="create-pysapscript-object">Create pysapscript object</h2> | ||
| <pre><code class="language-python">pss = pysapscript.Sapscript() | ||
| </code></pre> | ||
| <p>parameter <code>default_window_title: = "SAP Easy Access"</code></p> | ||
| <h2 id="launch-sap">Launch Sap</h2> | ||
| <pre><code class="language-python">pss.launch_sap( | ||
| sid="SQ4", | ||
| client="012", | ||
| user="robot_t", | ||
| password=os.getenv("secret_password") | ||
| ) | ||
| </code></pre> | ||
| <p>additional parameters:</p> | ||
| <pre><code class="language-python">root_sap_dir = Path(r"C:\Program Files (x86)\SAP\FrontEnd\SAPgui") | ||
| maximise = True | ||
| quit_auto = True | ||
| </code></pre> | ||
| <h2 id="attach-to-window">Attach to window:</h2> | ||
| <pre><code class="language-python">window = pss.attach_window(0, 0) | ||
| </code></pre> | ||
| <p>positional parameters (0, 0) -> (connection, session)</p> | ||
| <h2 id="quitting-sap">Quitting SAP:</h2> | ||
| <ul> | ||
| <li>will automatically quit if not specified differently</li> | ||
| <li>manual quitting: <code>pss.quit()</code></li> | ||
| </ul> | ||
| <h2 id="performing-action">Performing action:</h2> | ||
| <p>use SAP path starting with <code>wnd[0]</code> for element argumetns</p> | ||
| <pre><code>window.write(element, value) | ||
| window.press(element) | ||
| window.select(element) | ||
| window.read(element) | ||
| window.read_shell_table(element) | ||
| window.press_shell_button(element, button_name) | ||
| window.change_shell_checkbox(element, checkbox_name, boolean) | ||
| window.select_shell_rows(element, [0, 1, 2]) | ||
| html_content = window.read_html_viewer(element) | ||
| </code></pre> | ||
| <p>Another available actions…</p> | ||
| <ul> | ||
| <li>close window, open new window, start transaction, navigate, maximize</li> | ||
| </ul> | ||
| <details class="source"> | ||
| <summary> | ||
| <span>Expand source code</span> | ||
| </summary> | ||
| <pre><code class="python">""" | ||
| .. include:: ../README.md | ||
| """</code></pre> | ||
| </details> | ||
| </section> | ||
| <section> | ||
| <h2 class="section-title" id="header-submodules">Sub-modules</h2> | ||
| <dl> | ||
| <dt><code class="name"><a title="pysapscript.pysapscript" href="pysapscript.html">pysapscript.pysapscript</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt><code class="name"><a title="pysapscript.shell_table" href="shell_table.html">pysapscript.shell_table</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt><code class="name"><a title="pysapscript.types_" href="types_/index.html">pysapscript.types_</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt><code class="name"><a title="pysapscript.utils" href="utils/index.html">pysapscript.utils</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt><code class="name"><a title="pysapscript.window" href="window.html">pysapscript.window</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| </article> | ||
| <nav id="sidebar"> | ||
| <h1>Index</h1> | ||
| <div class="toc"> | ||
| <ul> | ||
| <li><a href="#description">Description</a></li> | ||
| <li><a href="#documentation">Documentation</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| <li><a href="#usage">Usage</a><ul> | ||
| <li><a href="#create-pysapscript-object">Create pysapscript object</a></li> | ||
| <li><a href="#launch-sap">Launch Sap</a></li> | ||
| <li><a href="#attach-to-window">Attach to window:</a></li> | ||
| <li><a href="#quitting-sap">Quitting SAP:</a></li> | ||
| <li><a href="#performing-action">Performing action:</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <ul id="index"> | ||
| <li><h3><a href="#header-submodules">Sub-modules</a></h3> | ||
| <ul> | ||
| <li><code><a title="pysapscript.pysapscript" href="pysapscript.html">pysapscript.pysapscript</a></code></li> | ||
| <li><code><a title="pysapscript.shell_table" href="shell_table.html">pysapscript.shell_table</a></code></li> | ||
| <li><code><a title="pysapscript.types_" href="types_/index.html">pysapscript.types_</a></code></li> | ||
| <li><code><a title="pysapscript.utils" href="utils/index.html">pysapscript.utils</a></code></li> | ||
| <li><code><a title="pysapscript.window" href="window.html">pysapscript.window</a></code></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.10.0</a>.</p> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.