Giter Club home page Giter Club logo

tk_tools's Introduction

Build Status

Documentation Status

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:

Button-Grid

Binary-Label:

Byte-Label

Calendar:

Calendar

Entry-Grid:

Entry-Grid

Multi-Slot Frame

Multi-Slot Frame

Graph:

Graph

Key-Value:

Key-Value

Label-Grid:

Label-Grid

LED: (size can be scaled)

LED

SevenSegment and SevenSegmentDisplay

Seven Segment Display

Gauge

Gauge

Gauge Documentation

Rotary-Scale: (Tachometer)

Rotary-Scale

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:

  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!

tk_tools's People

Contributors

aokiahishatsu avatar naejgz avatar reblochonmasque avatar slightlynybbled avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.