Metadata-Version: 2.0
Name: tk-tools
Version: 0.8.2
Summary: Tkinter-native toolset and widget library
Home-page: https://github.com/slightlynybbled/tk_tools
Author: Jason R. Jones
Author-email: slightlynybbled@gmail.com
License: MIT
Keywords: tkinter gui widgets
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Natural Language :: English
Requires-Dist: engineering-notation (>=0.5)
Requires-Dist: xlrd (>=1.0.0)
Requires-Dist: xlwt (>=1.0.0)

[![Build Status](https://travis-ci.org/slightlynybbled/tk_tools.svg?branch=master)](https://travis-ci.org/slightlynybbled/tk_tools)

[![Documentation Status](https://readthedocs.org/projects/tk-tools/badge/?version=latest)](http://tk-tools.readthedocs.io/en/latest/?badge=latest)

# 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.

Here are some examples screenshots of the widgets you can create:

#### Button-Grid:  

![Button-Grid](docs/img/button-grid.png)

#### Byte-Label:  

![Byte-Label](docs/img/byte-label.png)

#### Calendar:  

![Calendar](docs/img/calendar.png)

#### Dropdown:  

![Dropdown](docs/img/dropdown.png)

#### Entry-Grid:  

![Entry-Grid](docs/img/entry-grid.png)

#### Multi-Slot Frame

![Multi-Slot Frame](docs/img/multi-slot-frame.png)

#### Graph:  

![Graph](docs/img/graph.png)

#### Key-Value:  

![Key-Value](docs/img/key-value.png)

#### Label-Grid:  

![Label-Grid](docs/img/label-grid.png)

#### LED: (size can be scaled)  

![LED](docs/img/led.gif)

#### SevenSegment and SevenSegmentDisplay

![Seven Segment Display](docs/img/seven-segment-display.png)

#### Gauge

![Gauges](docs/img/gauges.png)

#### Rotary-Scale: (Tachymeter)    

![Rotary-Scale](docs/img/rotary-scale.png)

For more details, check out the [documentation](https://tk-tools.readthedocs.io).

# Testing

Currently, style-level tests are implemented.  To execute:

    flake8 tk_tools

# Contributions

Contributions for new widgets, documentation, tests, and resolving issues are welcomed.

Contribution guidelines:

1. Fork the repository to your account.
2. Clone your account repository to your local development environment.
3. Create/checkout a new branch appropriately named by feature, bug, issue number, whatever.
4. Make your changes on your branch. The ideal changes would:

 - have working examples in the examples directory
 - have documentation in the docs directory

5. Push your changes to your github account.
6. Create a pull request from within github.

All code is to be passing `flake8` before it is merged into master!


