jsktoolbox 1.2.3

Small sets of classes for various operations.

JskToolBox

JskToolBox provides curated sets of Python classes that support system automation, networking, configuration handling, and Tkinter-based GUI development. The documentation in docs/ offers module-by-module guides; the sections below highlight the available references.

Development Rules

The project uses Poetry for development workflows. Run project tools through poetry run <command>.

Code Formatting and Class Layout

• Format Python code with black via poetry run black .
• Validate style with poetry run pycodestyle
• Use full type annotations for methods, properties, and class-level constants
• Prefer single quotes unless double quotes are required
• Organize each class into ordered sections separated by 80-character markers such as # #[PUBLIC METHODS]####################################################################

Required class section order:

1. CONSTANTS
2. CONSTRUCTOR
3. PUBLIC PROPERTIES
4. PROTECTED PROPERTIES
5. PRIVATE PROPERTIES
6. PUBLIC METHODS
7. PROTECTED METHODS
8. PRIVATE METHODS
9. STATIC/CLASS METHODS
10. EOF as the single final marker of the module file

Methods and properties inside each section must be sorted alphabetically.

Versioning and Changelog

The project follows Semantic Versioning in X.Y.Z format.

• MAJOR for breaking API changes
• MINOR for backward-compatible features
• PATCH for fixes, small improvements, and refactoring
• Documentation-only changes do not require a version bump
• Code changes must update both pyproject.toml and jsktoolbox/__init__.py

Project history is tracked in CHANGELOG.md. Changelog entries use the format <type>: <subject> with these types: feat, fix, docs, style, refactor, test, chore.

For BData dictionary keys, use ReadOnlyClass constants with the narrowest sensible scope:

• __Keys for a single class
• _Keys for a shared module scope
• public NameKeys classes for project-wide reuse in easy-to-find public keys modules

Core Utilities

• AttribTool – base classes that restrict dynamic attribute creation and manage declared fields
  AttribTool Readme
• BaseTool – mixins for metadata reporting, data storage, logging, and threading used across the project
  BaseTool Readme
• RaiseTool – helpers that standardise exception formatting and error reporting
  RaiseTool Readme
• SystemTool – utilities for interacting with the host operating system
  SystemTool Readme

Configuration and Data

• ConfigTool – parsers and helpers for working with configuration files
  ConfigTool Readme
• DateTool – date/time conversions, validation, and formatting helpers
  DateTool Readme
• StringTool – routines for text manipulation and sanitising
  StringTool Readme

Logging and Networking

• LogsTool – components that assemble the project logging subsystem (queues, formatters, workers)
  LogsTool Readme
• NetTool – general-purpose classes for networking tasks
  NetTool Readme
• NetAddressTool – toolkits for IP addressing with dedicated IPv4 and IPv6 guides
  NetAddressTool Readme
  NetAddressTool IPv4 Readme
  NetAddressTool IPv6 Readme

Tkinter

• TkTool – Tk mixins, layout helpers, clipboard adapters, and reusable widgets (excluding the unreliable _TkClip)
  TkTool Readme

API Documentation

Complete API reference documentation is available:

• Generate Documentation: make docs or poetry run python generate_docs.py
• HTML Documentation: Open docs_api/build/html/index.html after generation
• Preferred Imports: PREFERRED_IMPORTS.md - Lazy import patterns
• AI Agent Guide: AI_AGENT_GUIDE.md - Integration guide for AI agents
• Code Examples: EXAMPLES_FOR_AI.md - Practical usage examples
• Project Changelog: CHANGELOG.md - Versioned history of project changes
• Module Index: API_INDEX.md - Quick reference of all modules
• API Structure: api_structure.json - Machine-readable API structure

Lazy Imports (Important)

The library uses lazy imports for performance. Use the preferred shorter patterns:

# ✓ Preferred (lazy loading)
from jsktoolbox.configtool import Config
from jsktoolbox.logstool import LoggerClient

# ✗ Avoid (works but longer)
from jsktoolbox.configtool.main import Config
from jsktoolbox.logstool.logs import LoggerClient

Quick Start

# Install dependencies
poetry install

# Generate all documentation
make docs

# Or use the script directly
poetry run python generate_docs.py

# Open documentation in browser
make docs-open

Examples

Examples demonstrating selected modules can be found in:

• docs/examples - Module examples
• EXAMPLES_FOR_AI.md - Complete code examples