tk-tools


Nametk-tools JSON
Version 0.16.0 PyPI version JSON
download
home_pagehttps://github.com/slightlynybbled/tk_tools
SummaryTkinter-native toolset and widget library
upload_time2022-06-01 19:47:19
maintainer
docs_urlNone
authorJason R. Jones
requires_python
licenseMIT
keywords tkinter gui widgets
VCS
bugtrack_url
requirements engineering-notation
Travis-CI
coveralls test coverage No coveralls.
            [![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](https://tk-tools.readthedocs.io/en/latest/_images/button-grid.png)

## Binary-Label:  

![Byte-Label](https://tk-tools.readthedocs.io/en/latest/_images/byte-label.png)

## Calendar:  

![Calendar](https://tk-tools.readthedocs.io/en/latest/_images/calendar.png)

## Entry-Grid:  

![Entry-Grid](https://tk-tools.readthedocs.io/en/latest/_images/entry-grid.png)

## Multi-Slot Frame

![Multi-Slot Frame](https://tk-tools.readthedocs.io/en/latest/_images/multi-slot-frame.png)

## Graph:  

![Graph](https://tk-tools.readthedocs.io/en/latest/_images/graph.png)

## Key-Value:  

![Key-Value](https://tk-tools.readthedocs.io/en/latest/_images/key-value.png)

## Label-Grid:  

![Label-Grid](https://tk-tools.readthedocs.io/en/latest/_images/label-grid.png)

## LED: (size can be scaled)  

![LED](https://tk-tools.readthedocs.io/en/latest/_images/led.gif)

## SevenSegment and SevenSegmentDisplay

![Seven Segment Display](https://tk-tools.readthedocs.io/en/latest/_images/seven-segment-display.png)

## Gauge

![Gauge](https://tk-tools.readthedocs.io/en/latest/_images/gauges.png)

![Gauge Documentation](https://tk-tools.readthedocs.io/en/latest/_images/gaugedoc.png)

## Rotary-Scale: (Tachometer)    

![Rotary-Scale](https://tk-tools.readthedocs.io/en/latest/_images/rotary-scale.png)

# Dependencies

This package is dependant on [engineering_notation](https://pypi.org/project/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

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!



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/slightlynybbled/tk_tools",
    "name": "tk-tools",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "tkinter gui widgets",
    "author": "Jason R. Jones",
    "author_email": "slightlynybbled@gmail.com",
    "download_url": "",
    "platform": null,
    "description": "[![Build Status](https://travis-ci.org/slightlynybbled/tk_tools.svg?branch=master)](https://travis-ci.org/slightlynybbled/tk_tools)\n\n[![Documentation Status](https://readthedocs.org/projects/tk-tools/badge/?version=latest)](http://tk-tools.readthedocs.io/en/latest/?badge=latest)\n\n# Purpose\n\nThis repository holds useful high-level widgets written in pure python.  \nThis library used type hints and requires Python 3.5+; it could, however, be back-ported to earlier Python versions without difficulty.\n\nFor more details, check out the [documentation](https://tk-tools.readthedocs.io).\n\nHere are some examples screenshots of the widgets you can create:\n\n## Button-Grid:  \n\n![Button-Grid](https://tk-tools.readthedocs.io/en/latest/_images/button-grid.png)\n\n## Binary-Label:  \n\n![Byte-Label](https://tk-tools.readthedocs.io/en/latest/_images/byte-label.png)\n\n## Calendar:  \n\n![Calendar](https://tk-tools.readthedocs.io/en/latest/_images/calendar.png)\n\n## Entry-Grid:  \n\n![Entry-Grid](https://tk-tools.readthedocs.io/en/latest/_images/entry-grid.png)\n\n## Multi-Slot Frame\n\n![Multi-Slot Frame](https://tk-tools.readthedocs.io/en/latest/_images/multi-slot-frame.png)\n\n## Graph:  \n\n![Graph](https://tk-tools.readthedocs.io/en/latest/_images/graph.png)\n\n## Key-Value:  \n\n![Key-Value](https://tk-tools.readthedocs.io/en/latest/_images/key-value.png)\n\n## Label-Grid:  \n\n![Label-Grid](https://tk-tools.readthedocs.io/en/latest/_images/label-grid.png)\n\n## LED: (size can be scaled)  \n\n![LED](https://tk-tools.readthedocs.io/en/latest/_images/led.gif)\n\n## SevenSegment and SevenSegmentDisplay\n\n![Seven Segment Display](https://tk-tools.readthedocs.io/en/latest/_images/seven-segment-display.png)\n\n## Gauge\n\n![Gauge](https://tk-tools.readthedocs.io/en/latest/_images/gauges.png)\n\n![Gauge Documentation](https://tk-tools.readthedocs.io/en/latest/_images/gaugedoc.png)\n\n## Rotary-Scale: (Tachometer)    \n\n![Rotary-Scale](https://tk-tools.readthedocs.io/en/latest/_images/rotary-scale.png)\n\n# Dependencies\n\nThis package is dependant on [engineering_notation](https://pypi.org/project/engineering-notation/), which is one of my other packages.\n\n# Testing\n\nBasic testing has been instantiated *however* it is currently limited.  To execute style testing:\n\n    flake8 tk_tools\n    \nTo execute automated tests:\n\n    py.test test.py\n    \nMore 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.\n\n# Contributions\n\nContributions for new widgets, documentation, tests, and resolving issues are welcomed.\n\nContribution guidelines:\n\n1. Fork the repository to your account.\n2. Clone your account repository to your local development environment.\n3. Create/checkout a new branch appropriately named by feature, bug, issue number, whatever.\n4. Make your changes on your branch. The ideal changes would:\n\n - have working examples in the examples directory\n - have documentation in the docs directory\n\n5. Push your changes to your github account.\n6. Create a pull request from within github.\n\nAll code is to be passing `flake8` before it is merged into master!\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Tkinter-native toolset and widget library",
    "version": "0.16.0",
    "split_keywords": [
        "tkinter",
        "gui",
        "widgets"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8d83a110add0b4e62fe51ee1acfb3fa4",
                "sha256": "3c1e343e02cbc7769fe8b36bf3ad04a47cf593936f87274a2fc99de7c20bdd5c"
            },
            "downloads": -1,
            "filename": "tk_tools-0.16.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8d83a110add0b4e62fe51ee1acfb3fa4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 173392,
            "upload_time": "2022-06-01T19:47:19",
            "upload_time_iso_8601": "2022-06-01T19:47:19.676910Z",
            "url": "https://files.pythonhosted.org/packages/0f/14/c9e03e6f8e00225ecffed24e12a8f99718a9b6b553272d9bded74a763445/tk_tools-0.16.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-01 19:47:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "slightlynybbled",
    "github_project": "tk_tools",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "engineering-notation",
            "specs": [
                [
                    ">=",
                    "0.5"
                ]
            ]
        }
    ],
    "lcname": "tk-tools"
}
        
Elapsed time: 0.03494s