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.
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 docsorpoetry run python generate_docs.py - HTML Documentation: Open
docs_api/build/html/index.htmlafter 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
- 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
1 maintainer
Metadata
1 maintainer
Release files for jsktoolbox 1.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jsktoolbox-1.2.4.tar.gz | 108.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsktoolbox-1.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 264.2 kB
Release files / jsktoolbox-1.2.4.tar.gz
| Download URL | jsktoolbox-1.2.4.tar.gz |
|---|---|
| Size | 108.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5cfc8c8b2f203898ebc82b255b9860f966a0b87ba7555b5f9e7c8fa317be7923
|
|
BLAKE2b-256 checksum How to use checksums |
f510618629b7fa3a8d76023929a6fe8c228c74e75fa2abf3f6b8714136c68d07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.14 Linux/6.4.0-150600.23.87-default
|
Release files / jsktoolbox-1.2.4-py3-none-any.whl
| Download URL | jsktoolbox-1.2.4-py3-none-any.whl |
|---|---|
| Size | 156.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c61a0ed1843a1a67435834822871d5409521fb8ca9b97aa8b0027ec77313faf4
|
|
BLAKE2b-256 checksum How to use checksums |
995b45c91ada60991d385f34f10cda0464272fcc6849db66bc9410e43b880fa0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.14 Linux/6.4.0-150600.23.87-default
|
