tkhelper

Name	tkhelper JSON
Version	2.1.0 JSON
	download
home_page
Summary	A module to display some customized tkinter modules
upload_time	2023-08-14 11:11:59
maintainer
docs_url	None
author
requires_python	>=3.6
license
keywords
VCS
bugtrack_url
requirements	colour Pillow
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Tkinter Helper

A module to display some customized tkinter modules.

## Getting Started

You may download this project directly from GitHub, or you may use Python's package manager(pip).

### Prerequisites

Please see [requirements.txt](requirements.txt) for prerequisites.

### Installing

Use pip to install this library.

```cmd, bash
pip install tkhelper
```

## Running the tests

Doctests and unit tests can be run.

### Running doctests

Use python doctest.

```cmd, bash
python -m doctest tkhelper\widgets.py tkhelper\progressbars\circular.py
```

### Running unit tests

Unit tests still in development.

## Example Usage

```python
import tkinter as tk
from tkhelper.widgets import ResizableLabel, ResizableButton
from tkhelper.progressbars.circular import TransparentSpinnerBar, SpinnerLoadingBar

root = tk.Tk()

circular_bar = TransparentSpinnerBar(root, kind=SpinnerLoadingBar)
def start_bar():
    circular_bar.start()
    resizable_button.config(
        command=stop_bar,
        text="Click the button to stop the circular loading bar"
    )

def stop_bar():
    circular_bar.stop()
    resizable_button.config(
        command=start_bar,
        text="Click the button to run the circular loading bar"
    )


resizable_label = ResizableLabel(
    root, text="Example resizable label",
    weight=0.9, resize=True
)
resizable_label.grid()

resizable_button = ResizableButton(
    root, text="Click the button to run the circular loading bar",
    weight=0.5, resize=True, command=start_bar
)
resizable_button.grid()

root.geometry("500x500")
root.mainloop()
```

## Version Info

Version 1.0.0.

## Authors

* **Erdogan Onal** - *Owner* - [Erdogan Onal](https://github.com/erdoganonal)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "tkhelper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Erdogan Onal <erdoganonal@windowslive.com>",
    "download_url": "https://files.pythonhosted.org/packages/59/a2/1fd82f9cbea13e3ccab8dc65c61fd4bee09352a8f7ac9f35f38ad6004efc/tkhelper-2.1.0.tar.gz",
    "platform": null,
    "description": "# Tkinter Helper\r\n\r\nA module to display some customized tkinter modules.\r\n\r\n## Getting Started\r\n\r\nYou may download this project directly from GitHub, or you may use Python's package manager(pip).\r\n\r\n### Prerequisites\r\n\r\nPlease see [requirements.txt](requirements.txt) for prerequisites.\r\n\r\n### Installing\r\n\r\nUse pip to install this library.\r\n\r\n```cmd, bash\r\npip install tkhelper\r\n```\r\n\r\n## Running the tests\r\n\r\nDoctests and unit tests can be run.\r\n\r\n### Running doctests\r\n\r\nUse python doctest.\r\n\r\n```cmd, bash\r\npython -m doctest tkhelper\\widgets.py tkhelper\\progressbars\\circular.py\r\n```\r\n\r\n### Running unit tests\r\n\r\nUnit tests still in development.\r\n\r\n## Example Usage\r\n\r\n```python\r\nimport tkinter as tk\r\nfrom tkhelper.widgets import ResizableLabel, ResizableButton\r\nfrom tkhelper.progressbars.circular import TransparentSpinnerBar, SpinnerLoadingBar\r\n\r\nroot = tk.Tk()\r\n\r\ncircular_bar = TransparentSpinnerBar(root, kind=SpinnerLoadingBar)\r\ndef start_bar():\r\n    circular_bar.start()\r\n    resizable_button.config(\r\n        command=stop_bar,\r\n        text=\"Click the button to stop the circular loading bar\"\r\n    )\r\n\r\ndef stop_bar():\r\n    circular_bar.stop()\r\n    resizable_button.config(\r\n        command=start_bar,\r\n        text=\"Click the button to run the circular loading bar\"\r\n    )\r\n\r\n\r\nresizable_label = ResizableLabel(\r\n    root, text=\"Example resizable label\",\r\n    weight=0.9, resize=True\r\n)\r\nresizable_label.grid()\r\n\r\nresizable_button = ResizableButton(\r\n    root, text=\"Click the button to run the circular loading bar\",\r\n    weight=0.5, resize=True, command=start_bar\r\n)\r\nresizable_button.grid()\r\n\r\nroot.geometry(\"500x500\")\r\nroot.mainloop()\r\n```\r\n\r\n## Version Info\r\n\r\nVersion 1.0.0.\r\n\r\n## Authors\r\n\r\n* **Erdogan Onal** - *Owner* - [Erdogan Onal](https://github.com/erdoganonal)\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A module to display some customized tkinter modules",
    "version": "2.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/erdoganonal/tk_helper/issues",
        "Homepage": "https://github.com/erdoganonal/tk_helper"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e62c32ea25113761b3d0dd4d52bee0ff7f12375228d9ab221a0a7ae7a2ffcba9",
                "md5": "0fb29dc8a11a89bcc91bfa00d2e37cbd",
                "sha256": "bd0220ea8114fb42a7f49dae4d8be1fb51f8955555b8605b063f5d6d4e0377fd"
            },
            "downloads": -1,
            "filename": "tkhelper-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0fb29dc8a11a89bcc91bfa00d2e37cbd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 24331,
            "upload_time": "2023-08-14T11:11:58",
            "upload_time_iso_8601": "2023-08-14T11:11:58.248090Z",
            "url": "https://files.pythonhosted.org/packages/e6/2c/32ea25113761b3d0dd4d52bee0ff7f12375228d9ab221a0a7ae7a2ffcba9/tkhelper-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59a21fd82f9cbea13e3ccab8dc65c61fd4bee09352a8f7ac9f35f38ad6004efc",
                "md5": "2e69e7c269295f68c1e05443b737fe49",
                "sha256": "db2b489d1b4baafe052294c2d122a9dccbb0ff5811ce396925cd2a90039782af"
            },
            "downloads": -1,
            "filename": "tkhelper-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e69e7c269295f68c1e05443b737fe49",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 24472,
            "upload_time": "2023-08-14T11:11:59",
            "upload_time_iso_8601": "2023-08-14T11:11:59.908455Z",
            "url": "https://files.pythonhosted.org/packages/59/a2/1fd82f9cbea13e3ccab8dc65c61fd4bee09352a8f7ac9f35f38ad6004efc/tkhelper-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-14 11:11:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "erdoganonal",
    "github_project": "tk_helper",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "colour",
            "specs": [
                [
                    "==",
                    "0.1.5"
                ]
            ]
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    "==",
                    "10.0.0"
                ]
            ]
        }
    ],
    "lcname": "tkhelper"
}