Purpose
This repository holds useful high-level widgets written in pure python.
This library used type hints and requires Python 3.5+; it could, however, be back-ported to earlier Python versions without difficulty.
For more details, check out the documentation.
Here are some examples screenshots of the widgets you can create:
Button-Grid:
Binary-Label:
Calendar:
Entry-Grid:
Multi-Slot Frame
Graph:
Key-Value:
Label-Grid:
LED: (size can be scaled)
SevenSegment and SevenSegmentDisplay
Gauge
Rotary-Scale: (Tachometer)
Dependencies
This package is dependant on engineering_notation, which is one of my other packages.
Testing
Basic testing has been instantiated however it is currently limited. To execute style testing:
flake8 tk_tools
To execute automated tests:
py.test test.py
More testing will be added to new widgets as they are brought online while further testing will be added to old widgets as the project matures.
Contributions
Contributions for new widgets, documentation, tests, and resolving issues are welcomed.
Contribution guidelines:
- Fork the repository to your account.
- Clone your account repository to your local development environment.
- Create/checkout a new branch appropriately named by feature, bug, issue number, whatever.
- Make your changes on your branch. The ideal changes would:
- have working examples in the examples directory
- have documentation in the docs directory
- Push your changes to your github account.
- Create a pull request from within github.
All code is to be passing flake8 before it is merged into master!