sapsucker 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. sapsucker-0.0.1/.env.example +7 -0
  2. sapsucker-0.0.1/.github/dependabot.yml +18 -0
  3. sapsucker-0.0.1/.github/workflows/codeql-analysis.yml +70 -0
  4. sapsucker-0.0.1/.github/workflows/coverage.yml +22 -0
  5. sapsucker-0.0.1/.github/workflows/dependabot_automerge.yml +18 -0
  6. sapsucker-0.0.1/.github/workflows/dev_test.yml +28 -0
  7. sapsucker-0.0.1/.github/workflows/formatting.yml +25 -0
  8. sapsucker-0.0.1/.github/workflows/no_byte_order_mark.yml +15 -0
  9. sapsucker-0.0.1/.github/workflows/packaging_test.yml +22 -0
  10. sapsucker-0.0.1/.github/workflows/python-publish.yml +62 -0
  11. sapsucker-0.0.1/.github/workflows/pythonlint.yml +26 -0
  12. sapsucker-0.0.1/.github/workflows/unittests.yml +26 -0
  13. sapsucker-0.0.1/.gitignore +141 -0
  14. sapsucker-0.0.1/.pre-commit-config.yaml +24 -0
  15. sapsucker-0.0.1/LICENSE +21 -0
  16. sapsucker-0.0.1/PKG-INFO +260 -0
  17. sapsucker-0.0.1/README.md +212 -0
  18. sapsucker-0.0.1/domain-specific-terms.txt +3 -0
  19. sapsucker-0.0.1/examples/sapsucker/alv_grid_export.py +74 -0
  20. sapsucker-0.0.1/examples/sapsucker/basic_navigation.py +45 -0
  21. sapsucker-0.0.1/examples/sapsucker/form_filling.py +45 -0
  22. sapsucker-0.0.1/examples/sapsucker/tree_navigation.py +59 -0
  23. sapsucker-0.0.1/pyproject.toml +107 -0
  24. sapsucker-0.0.1/requirements.txt +2 -0
  25. sapsucker-0.0.1/src/_sapsucker_version.py +1 -0
  26. sapsucker-0.0.1/src/sapsucker/__init__.py +52 -0
  27. sapsucker-0.0.1/src/sapsucker/_com.py +151 -0
  28. sapsucker-0.0.1/src/sapsucker/_errors.py +29 -0
  29. sapsucker-0.0.1/src/sapsucker/_factory.py +139 -0
  30. sapsucker-0.0.1/src/sapsucker/_types.py +118 -0
  31. sapsucker-0.0.1/src/sapsucker/components/__init__.py +124 -0
  32. sapsucker-0.0.1/src/sapsucker/components/application.py +127 -0
  33. sapsucker-0.0.1/src/sapsucker/components/base.py +334 -0
  34. sapsucker-0.0.1/src/sapsucker/components/button.py +28 -0
  35. sapsucker-0.0.1/src/sapsucker/components/checkbox.py +78 -0
  36. sapsucker-0.0.1/src/sapsucker/components/collection.py +69 -0
  37. sapsucker-0.0.1/src/sapsucker/components/combobox.py +78 -0
  38. sapsucker-0.0.1/src/sapsucker/components/connection.py +52 -0
  39. sapsucker-0.0.1/src/sapsucker/components/container.py +107 -0
  40. sapsucker-0.0.1/src/sapsucker/components/editor.py +127 -0
  41. sapsucker-0.0.1/src/sapsucker/components/field.py +161 -0
  42. sapsucker-0.0.1/src/sapsucker/components/grid.py +229 -0
  43. sapsucker-0.0.1/src/sapsucker/components/okcode.py +21 -0
  44. sapsucker-0.0.1/src/sapsucker/components/session.py +182 -0
  45. sapsucker-0.0.1/src/sapsucker/components/shell.py +172 -0
  46. sapsucker-0.0.1/src/sapsucker/components/statusbar.py +28 -0
  47. sapsucker-0.0.1/src/sapsucker/components/tab.py +19 -0
  48. sapsucker-0.0.1/src/sapsucker/components/table.py +103 -0
  49. sapsucker-0.0.1/src/sapsucker/components/toolbar.py +36 -0
  50. sapsucker-0.0.1/src/sapsucker/components/tree.py +131 -0
  51. sapsucker-0.0.1/src/sapsucker/components/window.py +194 -0
  52. sapsucker-0.0.1/src/sapsucker/login.py +239 -0
  53. sapsucker-0.0.1/src/sapsucker/models.py +34 -0
  54. sapsucker-0.0.1/src/sapsucker/py.typed +0 -0
  55. sapsucker-0.0.1/tox.ini +99 -0
@@ -0,0 +1,7 @@
1
+ # SAP GUI integration test credentials
2
+ # Copy this file to .env and fill in your values
3
+ SAP_CONNECTION_NAME=
4
+ SAP_USER=
5
+ SAP_PASSWORD=
6
+ SAP_MANDANT=
7
+ SAP_LANGUAGE=EN
@@ -0,0 +1,18 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "pip" # See documentation for possible values
9
+ directory: "/" # Location of package manifests
10
+ schedule:
11
+ interval: "weekly"
12
+ reviewers:
13
+ - "@Hochfrequenz/python-developers-review-team"
14
+ # Maintain dependencies for GitHub Actions
15
+ - package-ecosystem: "github-actions"
16
+ directory: "/"
17
+ schedule:
18
+ interval: "weekly"
@@ -0,0 +1,70 @@
1
+ # For most projects, this workflow file will not need changing; you simply need
2
+ # to commit it to your repository.
3
+ #
4
+ # You may wish to alter this file to override the set of languages analyzed,
5
+ # or to provide custom queries or build logic.
6
+ #
7
+ # ******** NOTE ********
8
+ # We have attempted to detect the languages in your repository. Please check
9
+ # the `language` matrix defined below to confirm you have the correct set of
10
+ # supported CodeQL languages.
11
+ #
12
+ name: "CodeQL"
13
+
14
+ on:
15
+ push:
16
+ branches: [main]
17
+ pull_request:
18
+ # The branches below must be a subset of the branches above
19
+ branches: [main]
20
+ schedule:
21
+ - cron: "29 14 * * 6"
22
+
23
+ jobs:
24
+ analyze:
25
+ name: Analyze
26
+ runs-on: ubuntu-latest
27
+ permissions:
28
+ actions: read
29
+ contents: read
30
+ security-events: write
31
+
32
+ strategy:
33
+ fail-fast: false
34
+ matrix:
35
+ language: ["python"]
36
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37
+ # Learn more about CodeQL language support at https://git.io/codeql-language-support
38
+
39
+ steps:
40
+ - name: Checkout repository
41
+ uses: actions/checkout@v6
42
+
43
+ # Initializes the CodeQL tools for scanning.
44
+ - name: Initialize CodeQL
45
+ uses: github/codeql-action/init@v4
46
+ with:
47
+ languages: ${{ matrix.language }}
48
+ # If you wish to specify custom queries, you can do so here or in a config file.
49
+ # By default, queries listed here will override any specified in a config file.
50
+ # Prefix the list here with "+" to use these queries and those in the config file.
51
+ # queries: ./path/to/local/query, your-org/your-repo/queries@main
52
+
53
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
54
+ # If this step fails, then you should remove it and run the build manually (see below)
55
+ - name: Autobuild
56
+ uses: github/codeql-action/autobuild@v4
57
+
58
+ # ℹ️ Command-line programs to run using the OS shell.
59
+ # 📚 https://git.io/JvXDl
60
+
61
+ # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
62
+ # and modify them (or add more) to build your code if your project
63
+ # uses a compiled language
64
+
65
+ #- run: |
66
+ # make bootstrap
67
+ # make release
68
+
69
+ - name: Perform CodeQL Analysis
70
+ uses: github/codeql-action/analyze@v4
@@ -0,0 +1,22 @@
1
+ name: "Coverage"
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ jobs:
8
+ coverage:
9
+ runs-on: windows-latest
10
+ steps:
11
+ - uses: actions/checkout@v6
12
+ - name: Set up Python
13
+ uses: actions/setup-python@v6
14
+ with:
15
+ python-version: 3.14
16
+ - name: Install dependencies
17
+ run: |
18
+ python -m pip install --upgrade pip
19
+ pip install tox
20
+ - name: Run Tests and Record Coverage
21
+ run: |
22
+ tox -e coverage
@@ -0,0 +1,18 @@
1
+ name: Dependabot auto-approve / -merge
2
+ on: pull_request
3
+
4
+ jobs:
5
+ dependabot:
6
+ permissions:
7
+ contents: write
8
+ pull-requests: write
9
+ runs-on: ubuntu-latest
10
+ env:
11
+ PR_URL: ${{github.event.pull_request.html_url}}
12
+ GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
13
+ if: ${{ github.actor == 'dependabot[bot]' }}
14
+ steps:
15
+ - name: Approve a PR
16
+ run: gh pr review --approve "$PR_URL"
17
+ - name: Enable auto-merge for Dependabot PRs
18
+ run: gh pr merge --auto --squash "$PR_URL"
@@ -0,0 +1,28 @@
1
+ name: "Test Dev Environment"
2
+ # Checks that the dev environment (tox -e dev) can be set up.
3
+ # This might not work, if different linting/testing envs refer to different versions of the same lib (e.g. typing-extensions).
4
+ # Different versions of the same package might work for isolated specific envs (only linting, only testing...) but the dev environment inherits from all of them.
5
+ on:
6
+ push:
7
+ branches: [main]
8
+ pull_request: {}
9
+ jobs:
10
+ check:
11
+ runs-on: ${{ matrix.os }}
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.11", "3.12", "3.13", "3.14"]
15
+ os: [windows-latest]
16
+ steps:
17
+ - uses: actions/checkout@v6
18
+ - name: Set up Python ${{ matrix.python-version }}
19
+ uses: actions/setup-python@v6
20
+ with:
21
+ python-version: ${{ matrix.python-version }}
22
+ - name: Install Dependencies
23
+ run: |
24
+ python -m pip install --upgrade pip
25
+ pip install tox
26
+ - name: Create a Dev Environment
27
+ run: |
28
+ tox -e dev
@@ -0,0 +1,25 @@
1
+ name: "Formatting"
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ jobs:
8
+ format:
9
+ runs-on: ubuntu-latest
10
+ strategy:
11
+ matrix:
12
+ tool: ["black", "isort"]
13
+ steps:
14
+ - uses: actions/checkout@v6
15
+ - name: Set up Python
16
+ uses: actions/setup-python@v6
17
+ with:
18
+ python-version: 3.14
19
+ - name: Install dependencies
20
+ run: |
21
+ python -m pip install --upgrade pip
22
+ pip install .[formatting]
23
+ - name: ${{ matrix.tool }} Code Formatter
24
+ run: |
25
+ ${{ matrix.tool }} . --check
@@ -0,0 +1,15 @@
1
+ name: Prevent ByteOrderMarks
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ pull_request: {}
8
+
9
+ jobs:
10
+ bom-check:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v6
14
+ - uses: arma-actions/bom-check@v1
15
+ name: Check for BOM
@@ -0,0 +1,22 @@
1
+ name: "Packaging Test"
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ jobs:
8
+ check_packaging:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v6
12
+ - name: Set up Python
13
+ uses: actions/setup-python@v6
14
+ with:
15
+ python-version: 3.14
16
+ - name: Install dependencies
17
+ run: |
18
+ python -m pip install --upgrade pip
19
+ pip install tox
20
+ - name: Run Packaging Test
21
+ run: |
22
+ tox -e test_packaging
@@ -0,0 +1,62 @@
1
+ # This workflow uploads a Python Package using Twine when a release is created.
2
+ # It requires the "release" environment configured in GitHub repo settings
3
+ # and a trusted publisher configured on PyPI.
4
+
5
+ name: Upload Python Package
6
+
7
+ on:
8
+ release:
9
+ types: [created, edited]
10
+
11
+ jobs:
12
+ tests:
13
+ if: startsWith(github.ref, 'refs/tags/v')
14
+ runs-on: ${{ matrix.os }}
15
+ strategy:
16
+ matrix:
17
+ python-version: ["3.14"]
18
+ os: [ubuntu-latest]
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+ - name: Set up Python ${{ matrix.python-version }}
22
+ uses: actions/setup-python@v5
23
+ with:
24
+ python-version: ${{ matrix.python-version }}
25
+ - name: Install tox
26
+ run: |
27
+ python -m pip install --upgrade pip
28
+ pip install tox
29
+ - name: Run tox
30
+ run: |
31
+ tox
32
+
33
+ build-n-publish:
34
+ name: Build and publish Python 🐍 distributions 📦 to PyPI
35
+ runs-on: ${{ matrix.os }}
36
+ strategy:
37
+ matrix:
38
+ python-version: ["3.14"]
39
+ os: [ubuntu-latest]
40
+ # Specifying a GitHub environment, which is strongly recommended by PyPI:
41
+ # https://docs.pypi.org/trusted-publishers/adding-a-publisher/
42
+ environment: release
43
+ permissions:
44
+ # IMPORTANT: this permission is mandatory for trusted publishing
45
+ id-token: write
46
+ needs: tests
47
+ steps:
48
+ - uses: actions/checkout@v4
49
+ - name: Set up Python ${{ matrix.python-version }}
50
+ uses: actions/setup-python@v5
51
+ with:
52
+ python-version: ${{ matrix.python-version }}
53
+ - name: Install dependencies
54
+ run: |
55
+ python -m pip install --upgrade pip
56
+ pip install .[packaging]
57
+ - name: Build wheel and source distributions
58
+ run: |
59
+ python -m build
60
+ - name: Publish distribution 📦 to PyPI
61
+ if: startsWith(github.ref, 'refs/tags/v')
62
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,26 @@
1
+ name: "Linting"
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ jobs:
8
+ pylint:
9
+ name: Python Code Quality and Lint
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ matrix:
13
+ linter-env: ["linting", "type_check", "spell_check"]
14
+ steps:
15
+ - uses: actions/checkout@v6
16
+ - name: Set up Python
17
+ uses: actions/setup-python@v6
18
+ with:
19
+ python-version: 3.14
20
+ - name: Install Dependencies
21
+ run: |
22
+ python -m pip install --upgrade pip
23
+ pip install tox
24
+ - name: Run ${{ matrix.linter-env }} via Tox
25
+ run: |
26
+ tox -e ${{ matrix.linter-env }}
@@ -0,0 +1,26 @@
1
+ name: "Unittests"
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request: {}
7
+ jobs:
8
+ pytest:
9
+ runs-on: ${{ matrix.os }}
10
+ strategy:
11
+ matrix:
12
+ python-version: ["3.11", "3.12", "3.13", "3.14"]
13
+ os: [windows-latest]
14
+ steps:
15
+ - uses: actions/checkout@v6
16
+ - name: Set up Python ${{ matrix.python-version }}
17
+ uses: actions/setup-python@v6
18
+ with:
19
+ python-version: ${{ matrix.python-version }}
20
+ - name: Install Dependencies
21
+ run: |
22
+ python -m pip install --upgrade pip
23
+ pip install tox
24
+ - name: Run the Unit Tests via Tox
25
+ run: |
26
+ tox -e tests
@@ -0,0 +1,141 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .venv
106
+ env/
107
+ venv/
108
+ ENV/
109
+ env.bak/
110
+ venv.bak/
111
+
112
+ # Spyder project settings
113
+ .spyderproject
114
+ .spyproject
115
+
116
+ # Rope project settings
117
+ .ropeproject
118
+
119
+ # mkdocs documentation
120
+ /site
121
+
122
+ # mypy
123
+ .mypy_cache/
124
+ .dmypy.json
125
+ dmypy.json
126
+
127
+ # Pyre type checker
128
+ .pyre/
129
+
130
+ .idea/
131
+
132
+ # vscode settings
133
+ .vscode/
134
+
135
+ src/_your_package_version.py
136
+ src/_sapsucker_version.py
137
+
138
+ # Environment variables
139
+
140
+ # Environment variables
141
+ .env
@@ -0,0 +1,24 @@
1
+ # to update all repo revisions just run: pre-commit autoupdate
2
+ repos:
3
+ - repo: https://github.com/pre-commit/pre-commit-hooks
4
+ rev: v4.4.0
5
+ hooks:
6
+ - id: check-yaml
7
+ - id: end-of-file-fixer
8
+ - id: trailing-whitespace
9
+ - repo: https://github.com/psf/black
10
+ rev: 23.9.1
11
+ hooks:
12
+ - id: black
13
+ language_version: python3
14
+ - repo: https://github.com/pycqa/isort
15
+ rev: 5.12.0
16
+ hooks:
17
+ - id: isort
18
+ name: isort (python)
19
+ - id: isort
20
+ name: isort (cython)
21
+ types: [cython]
22
+ - id: isort
23
+ name: isort (pyi)
24
+ types: [pyi]
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Hochfrequenz Unternehmensberatung GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.