plesty-sdk 0.0.2.dev2__py3-none-any.whl

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 (20) hide show
  1. plesty_sdk-0.0.2.dev2.dist-info/METADATA +59 -0
  2. plesty_sdk-0.0.2.dev2.dist-info/RECORD +20 -0
  3. plesty_sdk-0.0.2.dev2.dist-info/WHEEL +4 -0
  4. plesty_sdk-0.0.2.dev2.dist-info/entry_points.txt +2 -0
  5. plesty_sdk-0.0.2.dev2.dist-info/licenses/COPYING +674 -0
  6. plesty_sdk-0.0.2.dev2.dist-info/licenses/COPYING.LESSER +165 -0
  7. plesty_sdk-0.0.2.dev2.dist-info/licenses/LICENSE +165 -0
  8. plestysdk/__init__.py +1 -0
  9. plestysdk/assets/docs-build-gitlab-ci.yml +11 -0
  10. plestysdk/assets/logos/plesty_icon.png +0 -0
  11. plestysdk/assets/logos/plesty_logo.png +0 -0
  12. plestysdk/assets/ruff.toml +11 -0
  13. plestysdk/cache.py +106 -0
  14. plestysdk/cli.py +32 -0
  15. plestysdk/commands/check.py +146 -0
  16. plestysdk/commands/docs/__init__.py +35 -0
  17. plestysdk/commands/docs/deploy.py +193 -0
  18. plestysdk/commands/docs/serve.py +80 -0
  19. plestysdk/commands/docs/sphinx_builder.py +158 -0
  20. plestysdk/context.py +116 -0
plesty_sdk-0.0.2.dev2.dist-info/METADATA ADDED
@@ -0,0 +1,59 @@
1
+ Metadata-Version: 2.4
2
+ Name: plesty-sdk
3
+ Version: 0.0.2.dev2
4
+ Summary: Command-line application for developing Python modules compliant with the Plesty standard.
5
+ Author: Plesty Development Team
6
+ License-File: COPYING
7
+ License-File: COPYING.LESSER
8
+ License-File: LICENSE
9
+ Requires-Python: >=3.12
10
+ Requires-Dist: click>=3.8
11
+ Requires-Dist: livereload>=2.7.1
12
+ Requires-Dist: myst-parser>=5.0.0
13
+ Requires-Dist: pydata-sphinx-theme==0.17.1
14
+ Requires-Dist: ruff>=0.14
15
+ Requires-Dist: sphinx-autoapi>=3.6.1
16
+ Requires-Dist: sphinx-copybutton>=0.5.2
17
+ Requires-Dist: sphinx-design>=0.7.0
18
+ Requires-Dist: sphinx-external-toc>=1.1.0
19
+ Requires-Dist: sphinx>=9.1.0
20
+ Requires-Dist: sphinxcontrib-mermaid>=2.0.0
21
+ Requires-Dist: watchfiles>=1.1.1
22
+ Description-Content-Type: text/markdown
23
+
24
+ # plesty-sdk - Setting the Coding Standard
25
+
26
+
27
+ ### What to standardize:
28
+ 1. Code hygiene
29
+ 2. Documentation / examples
30
+ 3. Data standards
31
+ 4. Module-specific Integration standards (interfaces, version management, …) on different levels (unit, integration, end to end) and modules (device, instrument, analyzer)
32
+ 5. GUI
33
+ 6. Simulator / Testing
34
+ 7. Error management
35
+
36
+ The plesty-sdk module must check for those standards. It must be simple to use, well documented and verbose.
37
+
38
+
39
+ ### Standardization levels
40
+
41
+ The suggested levels of plesty standards are:
42
+
43
+ **Plexy Pixel (Easy):**
44
+ - Basic repository structure (readme, src, example?)
45
+ - Code Hygiene (#1) and documented example (#2)
46
+ - For executable modules: Standard vor execution (e.g. via uvx)
47
+
48
+ **Plexy Nebula (Intermediate):** Focus on basic functionality and interconnected modules
49
+ - #1 and #2 (extended),#3, #4, partial testing
50
+ (standards are just checked if exists, e.g. GUI)
51
+
52
+ **Plexy Quantum (Advanced):**
53
+ - Full check of all standardization goals
54
+ - modules with these standards should be able to all work together and be actively maintained (dependency management etc)
55
+
56
+
57
+ ## LICENSE
58
+ Plesty is licensed under the GNU Lesser General Public License v3.0 or later
59
+ (LGPL-3.0-or-later). See the LICENSE file.
plesty_sdk-0.0.2.dev2.dist-info/RECORD ADDED
@@ -0,0 +1,20 @@
1
+ plestysdk/__init__.py,sha256=m6UekKftTahNJ3W5K3mZSz4Y4ZZpHRxF_ZAxuaKYL7o,12
2
+ plestysdk/cache.py,sha256=EvqvGCj00oQEzoKij7LyfIX0Her_U9nrezChkZ-u7EQ,3878
3
+ plestysdk/cli.py,sha256=6IY-PvABpDxdl4f79QcvxdvzgErQByNv8acYlaj87ts,1123
4
+ plestysdk/context.py,sha256=4OR7gXMMTG9mbs_yvEj365du23VtuVqbgDQmA_85ENA,5017
5
+ plestysdk/assets/docs-build-gitlab-ci.yml,sha256=Ee-Iu1FymeGc7H93tVdBA-y5vJYNfCur4GVfEYNYd5s,185
6
+ plestysdk/assets/ruff.toml,sha256=aluT6IyKKC66_Z8X4OCQ9ujE1-Cf_mrnVCWCoHMZFMM,222
7
+ plestysdk/assets/logos/plesty_icon.png,sha256=yFrk2tQDGUzTTzRLdsbqUYwhe2YYa7VlXXfzZCUlIrk,18048
8
+ plestysdk/assets/logos/plesty_logo.png,sha256=QgqgLl3s8s-NmrtjTHG650uCzJwblwHwI62nc5IG1bg,15218
9
+ plestysdk/commands/check.py,sha256=xf_mVnece_KaGpmkJ_6oFXk9cdLPhayguSq7Ijp8zwk,5863
10
+ plestysdk/commands/docs/__init__.py,sha256=R7SMCSGhQrm8UM5GqscqdhdjTOmYoP-Zt3MlP7pctkY,1380
11
+ plestysdk/commands/docs/deploy.py,sha256=MJX97wKJKRJEn8_Ovj74Sr9VIirvZxfkyB5cuMjoB5c,8020
12
+ plestysdk/commands/docs/serve.py,sha256=U_6CUtmZFoK3joWBD4maLyX-pDEn4o9ont3ae7SW8ds,2796
13
+ plestysdk/commands/docs/sphinx_builder.py,sha256=DK1w8LAS36V5iKwz8JhSR15qGoecffF99djnutejofo,5392
14
+ plesty_sdk-0.0.2.dev2.dist-info/METADATA,sha256=ocYElNE8o7bPko2QWYHRpK_Ux7GD_8k5Mm7oCNblWUM,2001
15
+ plesty_sdk-0.0.2.dev2.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
16
+ plesty_sdk-0.0.2.dev2.dist-info/entry_points.txt,sha256=fNrx7o8Sf1lQfZJM-_uPYcPWbJMO94RAYh7z-DnGB5o,45
17
+ plesty_sdk-0.0.2.dev2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
18
+ plesty_sdk-0.0.2.dev2.dist-info/licenses/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
19
+ plesty_sdk-0.0.2.dev2.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
20
+ plesty_sdk-0.0.2.dev2.dist-info/RECORD,,
plesty_sdk-0.0.2.dev2.dist-info/WHEEL ADDED
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.29.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
plesty_sdk-0.0.2.dev2.dist-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ plesty = plestysdk.cli:app