appxc 0.0.3.dev384__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 (73) hide show
  1. appxc-0.0.3.dev384/.gitignore +27 -0
  2. appxc-0.0.3.dev384/CONTRIBUTORS +7 -0
  3. appxc-0.0.3.dev384/LICENSE +50 -0
  4. appxc-0.0.3.dev384/LICENSES/0BSD +3 -0
  5. appxc-0.0.3.dev384/LICENSES/Apache-2.0 +202 -0
  6. appxc-0.0.3.dev384/PKG-INFO +51 -0
  7. appxc-0.0.3.dev384/README.md +28 -0
  8. appxc-0.0.3.dev384/pyproject.toml +188 -0
  9. appxc-0.0.3.dev384/src/appxc/__init__.py +25 -0
  10. appxc-0.0.3.dev384/src/appxc/build/__init__.py +6 -0
  11. appxc-0.0.3.dev384/src/appxc/build/pyinstaller.py +409 -0
  12. appxc-0.0.3.dev384/src/appxc/config/__init__.py +5 -0
  13. appxc-0.0.3.dev384/src/appxc/config/cleanup_parts.py +18 -0
  14. appxc-0.0.3.dev384/src/appxc/config/config.py +152 -0
  15. appxc-0.0.3.dev384/src/appxc/email/__init__.py +3 -0
  16. appxc-0.0.3.dev384/src/appxc/email/sendmail.py +145 -0
  17. appxc-0.0.3.dev384/src/appxc/fileversions.py +197 -0
  18. appxc-0.0.3.dev384/src/appxc/gui/__init__.py +22 -0
  19. appxc-0.0.3.dev384/src/appxc/gui/application.py +169 -0
  20. appxc-0.0.3.dev384/src/appxc/gui/common.py +551 -0
  21. appxc-0.0.3.dev384/src/appxc/gui/config.py +139 -0
  22. appxc-0.0.3.dev384/src/appxc/gui/locale.py +19 -0
  23. appxc-0.0.3.dev384/src/appxc/gui/login.py +206 -0
  24. appxc-0.0.3.dev384/src/appxc/gui/manual_config_update.py +111 -0
  25. appxc-0.0.3.dev384/src/appxc/gui/registration_admin.py +385 -0
  26. appxc-0.0.3.dev384/src/appxc/gui/registration_user.py +313 -0
  27. appxc-0.0.3.dev384/src/appxc/gui/setting_base.py +176 -0
  28. appxc-0.0.3.dev384/src/appxc/gui/setting_dict.py +335 -0
  29. appxc-0.0.3.dev384/src/appxc/gui/setting_select.py +356 -0
  30. appxc-0.0.3.dev384/src/appxc/locale/appxc-gui.pot +131 -0
  31. appxc-0.0.3.dev384/src/appxc/locale/de/LC_MESSAGES/appxc-gui.po +134 -0
  32. appxc-0.0.3.dev384/src/appxc/locale/en/LC_MESSAGES/appxc-gui.po +131 -0
  33. appxc-0.0.3.dev384/src/appxc/logging.py +144 -0
  34. appxc-0.0.3.dev384/src/appxc/options.py +202 -0
  35. appxc-0.0.3.dev384/src/appxc/pyinstaller/__init__.py +18 -0
  36. appxc-0.0.3.dev384/src/appxc/pyinstaller/hook-appxc_private.py +10 -0
  37. appxc-0.0.3.dev384/src/appxc/registry/__init__.py +12 -0
  38. appxc-0.0.3.dev384/src/appxc/registry/_public_encryption.py +41 -0
  39. appxc-0.0.3.dev384/src/appxc/registry/_registration_request.py +92 -0
  40. appxc-0.0.3.dev384/src/appxc/registry/_registration_response.py +71 -0
  41. appxc-0.0.3.dev384/src/appxc/registry/_registry_base.py +81 -0
  42. appxc-0.0.3.dev384/src/appxc/registry/_signature.py +57 -0
  43. appxc-0.0.3.dev384/src/appxc/registry/_user_db.py +291 -0
  44. appxc-0.0.3.dev384/src/appxc/registry/_user_id.py +43 -0
  45. appxc-0.0.3.dev384/src/appxc/registry/registry.py +821 -0
  46. appxc-0.0.3.dev384/src/appxc/registry/shared_storage.py +202 -0
  47. appxc-0.0.3.dev384/src/appxc/registry/shared_sync.py +76 -0
  48. appxc-0.0.3.dev384/src/appxc/security/__init__.py +6 -0
  49. appxc-0.0.3.dev384/src/appxc/security/private_storage.py +79 -0
  50. appxc-0.0.3.dev384/src/appxc/security/security.py +588 -0
  51. appxc-0.0.3.dev384/src/appxc/setting/__init__.py +45 -0
  52. appxc-0.0.3.dev384/src/appxc/setting/base_types.py +299 -0
  53. appxc-0.0.3.dev384/src/appxc/setting/setting.py +604 -0
  54. appxc-0.0.3.dev384/src/appxc/setting/setting_dict.py +631 -0
  55. appxc-0.0.3.dev384/src/appxc/setting/setting_extension.py +94 -0
  56. appxc-0.0.3.dev384/src/appxc/setting/setting_select.py +271 -0
  57. appxc-0.0.3.dev384/src/appxc/stateful.py +210 -0
  58. appxc-0.0.3.dev384/src/appxc/storage/__init__.py +33 -0
  59. appxc-0.0.3.dev384/src/appxc/storage/buffer.py +164 -0
  60. appxc-0.0.3.dev384/src/appxc/storage/ftp.py +157 -0
  61. appxc-0.0.3.dev384/src/appxc/storage/local.py +88 -0
  62. appxc-0.0.3.dev384/src/appxc/storage/meta_data.py +30 -0
  63. appxc-0.0.3.dev384/src/appxc/storage/ram.py +100 -0
  64. appxc-0.0.3.dev384/src/appxc/storage/serializer.py +34 -0
  65. appxc-0.0.3.dev384/src/appxc/storage/serializer_compact.py +76 -0
  66. appxc-0.0.3.dev384/src/appxc/storage/serializer_json.py +160 -0
  67. appxc-0.0.3.dev384/src/appxc/storage/serializer_raw.py +19 -0
  68. appxc-0.0.3.dev384/src/appxc/storage/storable.py +61 -0
  69. appxc-0.0.3.dev384/src/appxc/storage/storage.py +821 -0
  70. appxc-0.0.3.dev384/src/appxc/storage/storage_to_bytes.py +65 -0
  71. appxc-0.0.3.dev384/src/appxc/storage/sync.py +262 -0
  72. appxc-0.0.3.dev384/src/appxc/utility/__init__.py +5 -0
  73. appxc-0.0.3.dev384/src/appxc/utility/ntptime.py +111 -0
@@ -0,0 +1,27 @@
1
+ # development environment
2
+ .venv
3
+ .vscode
4
+ *.code-workspace
5
+
6
+ # temporary directories (backup files, local builds, tests, etc.)
7
+ __pycache__
8
+ .coverage
9
+ .env
10
+ .testing
11
+ .tox
12
+ *.drawio.bkp
13
+ *.bkp-*
14
+ *.mo
15
+ cov_*
16
+ dist
17
+ doc/_build
18
+ plantuml.jar
19
+
20
+ # generated by hatch-vcs at build time – do not commit
21
+ src/appxc/_version.py
22
+
23
+ # notes during development
24
+ __*.md
25
+ # stored github tokens
26
+ gh_token
27
+ gh_token_classic
@@ -0,0 +1,7 @@
1
+ The following authors contributed to the APPXC project. They are listed based
2
+ on their github profile in alphabetical order.
3
+
4
+ github.com/
5
+ alexander-nbg
6
+
7
+ See git log for individual contributions where commits may use different author references.
@@ -0,0 +1,50 @@
1
+ The APPXC project applies either
2
+ * Apache-2.0 (Apache License 2.0) OR
3
+ * 0BSD (BSD Zero Clause License)
4
+ with license texts available in the LICENSES subfolder. There is no default
5
+ license for any file. Each file specifies it's applicable license using SPDX
6
+ tags. Files for which license tags are not available, are listed below.
7
+
8
+ The following guideline applies while the specification for each file remains
9
+ binding:
10
+ * Apache 2.0 for [src, tests, tests_features] folders with python source files
11
+ and tranlation PO files.
12
+ * 0BSD for [.github, doc, scripts] with general scripts, CI automation and
13
+ documentation.
14
+
15
+ FILES WITHOUT LICENSE TAGS
16
+ ==========================
17
+ APPXC scans all maintained files for copyright and license information as part
18
+ of the CI pipeline. Since the listing below is used as exclusion filter, it is
19
+ quite verbose.
20
+
21
+ Apache-2.0 licenses
22
+ -------------------
23
+ Apache-2.0 license applies with copyright by the contributors of APPXC
24
+ (github.com/alexander-nbg/appxc) to:
25
+ * src/requirements.txt
26
+ * tests/requirements.txt
27
+
28
+ 0BSD license
29
+ ------------
30
+ 0BSD license applies with copyright by the contributors of APPXC
31
+ (github.com/alexander-nbg/appxc) to:
32
+ * LICENSE
33
+ * CONTRIBUTORS
34
+ * .gitignore
35
+ * .github/ISSUE_TEMPLATE/*.md
36
+ * .github/copilot-instructions.md
37
+ * *.drawio
38
+ * dev/requirements.txt
39
+ Those files belong to the documentation:
40
+ * doc/requirements.txt
41
+ * doc/conf.py
42
+ To avoid AI's needing to digest license information, it is not included:
43
+ * AGENTS.md
44
+
45
+ No license
46
+ ----------
47
+ The following files are not licensed:
48
+ * LICENSES/*
49
+ The baseline file of basedpyright findings, generated by basedpyright:
50
+ * .basedpyright/baseline.json
@@ -0,0 +1,3 @@
1
+ Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
2
+
3
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROMLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,51 @@
1
+ Metadata-Version: 2.4
2
+ Name: appxc
3
+ Version: 0.0.3.dev384
4
+ Summary: APPXC application (APP) cross functional concerns (XC)
5
+ Project-URL: Repository, https://github.com/alexander-nbg/appxc
6
+ Project-URL: Issues, https://github.com/alexander-nbg/appxc/issues
7
+ Project-URL: Documentation, https://appxc.readthedocs.io/en/stable
8
+ Author-email: alexander-nbg <mail@alexander-nbg.de>
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Classifier: Development Status :: 1 - Planning
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
15
+ Requires-Python: >=3.10
16
+ Requires-Dist: babel
17
+ Requires-Dist: cryptography
18
+ Requires-Dist: email-validator
19
+ Requires-Dist: ftputil
20
+ Requires-Dist: ntplib
21
+ Requires-Dist: recordclass
22
+ Description-Content-Type: text/markdown
23
+
24
+ <!--Copyright 2026 the contributors of APPXC (github.com/alexander-nbg/appxc)-->
25
+ <!--SPDX-License-Identifier: 0BSD-->
26
+ # APPXC
27
+ APPXC covers an application's (APP) cross-cutting concerns (XC), such as
28
+ settings, data sharing, logging, and secure storage, to reduce effort when
29
+ writing desktop applications.
30
+
31
+ ## What it is
32
+ As of February 2026, around three years of hobbyist development
33
+ have been transferred into this public repository. It is *working code* that is
34
+ used in an application for a small association. While there are several usable
35
+ components, the *interfaces are unstable* and there is *no consistent
36
+ documentation*.
37
+
38
+ ## It may become
39
+ APPXC may help close a gap when writing applications for
40
+ small associations or non-profits. Development will continue with the clear
41
+ understanding that one person’s free time cannot accomplish everything.
42
+
43
+ ## Appreciation is Welcome
44
+ If you find any part of this library useful, the currently best motivation and
45
+ acknowledgement would be shareíng your story and project as a [discussion
46
+ topic](https://github.com/alexander-nbg/appxc/discussions/new?category=show-and-tell)
47
+ (example: [the app which initialized
48
+ APPXC](https://github.com/alexander-nbg/appxc/discussions/10)). Additionally,
49
+ while APPXC will not suddenly clean up all open topics or guarantee interface
50
+ stability for features which are relevant to you, efforts are continuously
51
+ prioritized based on the information available.
@@ -0,0 +1,28 @@
1
+ <!--Copyright 2026 the contributors of APPXC (github.com/alexander-nbg/appxc)-->
2
+ <!--SPDX-License-Identifier: 0BSD-->
3
+ # APPXC
4
+ APPXC covers an application's (APP) cross-cutting concerns (XC), such as
5
+ settings, data sharing, logging, and secure storage, to reduce effort when
6
+ writing desktop applications.
7
+
8
+ ## What it is
9
+ As of February 2026, around three years of hobbyist development
10
+ have been transferred into this public repository. It is *working code* that is
11
+ used in an application for a small association. While there are several usable
12
+ components, the *interfaces are unstable* and there is *no consistent
13
+ documentation*.
14
+
15
+ ## It may become
16
+ APPXC may help close a gap when writing applications for
17
+ small associations or non-profits. Development will continue with the clear
18
+ understanding that one person’s free time cannot accomplish everything.
19
+
20
+ ## Appreciation is Welcome
21
+ If you find any part of this library useful, the currently best motivation and
22
+ acknowledgement would be shareíng your story and project as a [discussion
23
+ topic](https://github.com/alexander-nbg/appxc/discussions/new?category=show-and-tell)
24
+ (example: [the app which initialized
25
+ APPXC](https://github.com/alexander-nbg/appxc/discussions/10)). Additionally,
26
+ while APPXC will not suddenly clean up all open topics or guarantee interface
27
+ stability for features which are relevant to you, efforts are continuously
28
+ prioritized based on the information available.
@@ -0,0 +1,188 @@
1
+ # Copyright 2026 the contributors of APPXC (github.com/alexander-nbg/appxc)
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ [project]
4
+ name = "appxc"
5
+ dynamic = ["version", "dependencies"]
6
+ authors = [
7
+ { name = "alexander-nbg", email="mail@alexander-nbg.de" }
8
+ ]
9
+ description = "APPXC application (APP) cross functional concerns (XC)"
10
+ readme = "README.md"
11
+ requires-python = ">=3.10"
12
+ classifiers = [
13
+ "Programming Language :: Python :: 3",
14
+ "Operating System :: OS Independent",
15
+ "Development Status :: 1 - Planning",
16
+ "Topic :: Software Development :: Libraries :: Application Frameworks",
17
+ ]
18
+ license="Apache-2.0"
19
+ license_file = "LICENSES/Apache-2.0"
20
+
21
+ [project.urls]
22
+ Repository = "https://github.com/alexander-nbg/appxc"
23
+ Issues = "https://github.com/alexander-nbg/appxc/issues"
24
+ Documentation = "https://appxc.readthedocs.io/en/stable"
25
+
26
+ [build-system]
27
+ requires = ["hatchling", "hatch-vcs", "hatch-requirements-txt"]
28
+ build-backend = "hatchling.build"
29
+
30
+ [tool.hatch.version]
31
+ source = "vcs"
32
+
33
+ [tool.hatch.version.raw-options]
34
+ version_scheme = "guess-next-dev"
35
+
36
+ [tool.hatch.metadata.hooks.requirements_txt]
37
+ files = ["src/requirements.txt"]
38
+
39
+ [tool.hatch.build]
40
+ include = [
41
+ # Library package only; appxc_dev and appxc_matema are not shipped to PyPI.
42
+ "src/appxc/",
43
+ # Additional information:
44
+ "/LICENSE",
45
+ "/LICENSES/",
46
+ "/README.md",
47
+ "/CONTRIBUTORS",
48
+ ]
49
+
50
+ [tool.hatch.build.targets.wheel]
51
+ packages = ["src/appxc"]
52
+
53
+ [project.entry-points.pyinstaller40]
54
+ hook-dirs = "appxc.pyinstaller:get_hook_dirs"
55
+
56
+ [tool.appxc]
57
+ # The testing sandbox is the root directory where files are placed that are
58
+ # needed or generated during test case. Each test case should use individual
59
+ # subfolders.
60
+ test-sandbox-root = "./.testing"
61
+
62
+ [tool.ruff]
63
+ # Note: Line length default is already 88. Minimum python version is taken from project
64
+ # configuration.
65
+
66
+ [tool.ruff.lint]
67
+ # Remark: The selected rules are not ciceled in stone. Start discussing, if there are
68
+ # good reasons to change.
69
+ select = ["ALL"]
70
+ ignore = [
71
+ # EXCLUDED RULES
72
+ # --------------
73
+ # Feel free to add any rule which is conflicting with the ruff formater. Those rules
74
+ # were typically NOT added by default since style consistency was valued higher than
75
+ # the irritation of adding them here, later. Exception was COM812 with the very
76
+ # irritating warning message upon [ruff format]. See also:
77
+ # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules.
78
+ "COM812", # Conflicts with formater AND causes warning message on [ruff format]
79
+ "EM", # avoid extra code and accept duplication in error messages
80
+ "FIX002", # Even in an APPXC v1.0.0, TODO remarks remain being allowed if a
81
+ # corresponding ticket was created, is linked and still actove (TODO #42).
82
+ # Despite TODO, no other tag should be used and other FIX rules remain in
83
+ # place.
84
+ "TC001", "TC003", # import readability over minor performance improvement
85
+ "TD", # rules for TODO in APPXC do not follow this pattern
86
+ "C901", # Complexity shall be rated by reviewers
87
+ "FBT", # boolean positional arguments are common for set(key, value) patterns and
88
+ # requiring an extra * to enforce named keyword arguments messes up the function
89
+ # definition. Issues can be identified in review.
90
+ "PLR0911", "PLR0912", "PLR0913", "PLR0915", # "too many" to be rated by reviewers
91
+ "PLW2901", # changing loop variable is considered OK
92
+ "RET504", # naming the return value does not do any harm
93
+
94
+ # PENDING RULES: The activation/fixing of the following rules is delayed and a
95
+ # strategy to decrease numbers over time will be in place.
96
+ #
97
+ # TODO #55: the decrease over time strategy.
98
+ "ANN", "ARG001", "ARG002", "BLE001", "D", "ERA001", "PLR2004", "PT", "PTH",
99
+ "RUF100", "SLF001", "T201", "TRY003"
100
+ ]
101
+
102
+ [tool.ruff.format]
103
+ # no specific settings here, yet
104
+
105
+ [tool.ruff.lint.flake8-annotations]
106
+ allow-star-arg-any = true
107
+ mypy-init-return = true
108
+ suppress-none-returning = true
109
+
110
+ [tool.ruff.lint.per-file-ignores]
111
+ # Unused imports in __init__.py are intentional re-exports.
112
+ "__init__.py" = ["F401"]
113
+ # TODO: This may be an issue since in some occasions, it causes unwanted dependencies.
114
+ # Example: when storage activated FTP again, any usage of storage would also import the
115
+ # dependency to FTP. This is acceptable for now, but not on the long run. Despite the
116
+ # other solutions (adding to __all__ and maxing the re-imports explicit with [import XY
117
+ # as XY]), merging classes into appropriate longer module files would enable dropping
118
+ # the module facade in __init__.py.
119
+
120
+ # Rules are relaxed for test case implementation
121
+ "tests*/**/*.py" = [
122
+ "ANN", # relaxing on type annotations
123
+ "ARG", # relaxing on unused arguments and alike
124
+ "ERA001", # commented out code is acceptable
125
+ "FBT002", # allow boolean positional arguments (not enforcing as keyword-argument)
126
+ "FURB171", # "something in [1] is quite OK in test code
127
+ "INP001", # no __init__.py package init for test code
128
+ "PLR", # refactoring suggestions OK to ignore
129
+ "T201", # print statements in tests are OK
130
+ "TRY", # allow quick-to-implement error handling in tests
131
+ "S", # No security checks for test code
132
+ ]
133
+ "tests/**/*.py" = [
134
+ "SLF001" # accessing private members in UT's is OK (but not in feature tests)
135
+ ]
136
+
137
+ "doc/**/*.py" = [
138
+ "INP001" # no __init.py__ for doc configuration
139
+ ]
140
+
141
+ # TODO: matema is generally in draft status and not usable. Disabling security checks.
142
+ "src/appxc_matema/**/*.py" = [
143
+ "ARG", "S603", "S607", "T201"
144
+ ]
145
+
146
+ # development scripts are not part of the shipped library and are only running locally
147
+ # and within CI (not in user applications)
148
+ "src/appxc_dev/**/*.py" = [
149
+ "S607", # partial executable paths are acceptable in dev-script context
150
+ "T201" # print statements OK in dev scripts
151
+ ]
152
+
153
+ [tool.basedpyright]
154
+ include = ["src"]
155
+ # This is a very initial setup of basedpyright which is intended to evolve over time.
156
+
157
+ [tool.tox]
158
+ legacy_tox_ini = """
159
+ [tox]
160
+ isolated_build = True
161
+ env_list = py310, py312
162
+
163
+ [gh-actions]
164
+ python =
165
+ 3.10: py310
166
+ 3.12: py312
167
+
168
+ [testenv]
169
+ passenv = APPXC_*
170
+ setenv = PYTHONPATH = {toxinidir}
171
+ VIRTUALENV_DOWNLOAD=0
172
+ deps =
173
+ -r{toxinidir}/src/requirements.txt
174
+ -r{toxinidir}/tests/requirements.txt
175
+
176
+ commands = pytest -rA tests/fixtures/application.py::test_cleanup
177
+ coverage erase
178
+ coverage run --source=appxc --context=UNIT --branch -m pytest -rA ./tests/unit
179
+ coverage report --contexts=UNIT
180
+ coverage html --contexts=UNIT -d cov_html_UNIT
181
+ coverage run -a --source=appxc --context=ACCEPTANCE --branch -m pytest -rA ./tests/acceptance
182
+ coverage report --contexts=ACCEPTANCE
183
+ coverage html --contexts=ACCEPTANCE -d cov_html_ACCEPTANCE
184
+ coverage report
185
+ coverage html -d cov_html
186
+ """
187
+ # commands = pytest --cov=appxc --cov-report html --cov-report term
188
+ # commands = coverage run --source src -m pytest
@@ -0,0 +1,25 @@
1
+ # Copyright 2023-2026 the contributors of APPXC (github.com/alexander-nbg/appxc)
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ """Facade for APPXC basic classes"""
4
+ # Basic classes exposed here shall only have dependencies to python builtin
5
+ # modules. This facade shall not expose any object from sub-modules. Rationale:
6
+ # using APPXC shall not enforce loading of unnecessary dependencies which are
7
+ # typically present in sub-modules.
8
+
9
+ # try:
10
+ # from ._version import __version__ as __version__
11
+ # except ImportError:
12
+ # # Package was not installed; version metadata is unknown (e.g. running directly
13
+ # # from source without hatch-vcs build hook execution).
14
+ # __version__: str = "0.0.0.dev0+unknown"
15
+
16
+ from importlib.metadata import PackageNotFoundError, version
17
+
18
+ try:
19
+ __version__ = version("package-name")
20
+ except PackageNotFoundError:
21
+ # package is not installed
22
+ __version__ = "0.0.0.dev0+unknown"
23
+
24
+ from .options import Options
25
+ from .stateful import Stateful
@@ -0,0 +1,6 @@
1
+ # Copyright 2026 the contributors of APPXC (github.com/alexander-nbg/appxc)
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ """Facade for APPXC build utilities"""
4
+
5
+ # TODO: when growing, this module also include other development tools and need
6
+ # renaming.