plesty-sdk 0.0.2.dev5

Command-line application for developing Python modules compliant with the Plesty standard.

plesty-sdk - Setting the Coding Standard

What to standardize:

1. Code hygiene
2. Documentation / examples
3. Data standards
4. Module-specific Integration standards (interfaces, version management, …) on different levels (unit, integration, end to end) and modules (device, instrument, analyzer)
5. GUI
6. Simulator / Testing
7. Error management

The plesty-sdk module must check for those standards. It must be simple to use, well documented and verbose.

Standardization levels

The suggested levels of plesty standards are:

Plexy Pixel (Easy):

• Basic repository structure (readme, src, example?)
• Code Hygiene (#1) and documented example (#2)
• For executable modules: Standard vor execution (e.g. via uvx)

Plexy Nebula (Intermediate): Focus on basic functionality and interconnected modules

• #1 and #2 (extended),#3, #4, partial testing (standards are just checked if exists, e.g. GUI)

Plexy Quantum (Advanced):

• Full check of all standardization goals
• modules with these standards should be able to all work together and be actively maintained (dependency management etc)

LICENSE

Plesty is licensed under the GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later). See the LICENSE file.