Skip to main content

Tkinter-native toolset and widget library

Project description

[![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.

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

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

#### Button-Grid:

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

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

![Gauge](docs/img/gauges.png) ![Gauge Documentation](docs/img/gaugedoc.png)

#### Rotary-Scale: (Tachymeter)

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

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

  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

  1. Push your changes to your github account.

  2. Create a pull request from within github.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

tk_tools-0.9.7-py3-none-any.whl (173.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page