tkr


Nametkr JSON
Version 0.2.1.post1 PyPI version JSON
download
home_pagehttps://github.com/toolkitr/tkr
SummaryPython Toolkit
upload_time2023-11-18 09:26:24
maintainer
docs_urlNone
authortlkr.
requires_python>=3.10.0,<3.12
licenseThe MIT License (MIT) Copyright (c) 2023 toolkitr Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords tkr toolkitr
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div id="header">
  <img src="https://i.ibb.co/P6fHtgc/tkr-social-preview.png" width="500"/>
</div>

# [TKR - Python Toolkit](https://pypi.org/project/tkr/)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toolkitr/tkr/blob/main/LICENSE)
[![Python Versions](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20-blue)](https://www.python.org/downloads/)

```Allow python developers to easily manage classes, methods, and more!```
<p align="left"> <a href="https://www.python.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg" alt="python" width="40" height="40"/></a></p>

## Installing
```shell
# Linux/macOS
python3 -m pip install -U tkr

# Windows
py -3 -m pip install -U tkr
```
Development Version:
```shell
$ git clone https://github.com/toolkitr/tkr
$ cd tkr
```

# Simple Examples
```python
import tkr

def tkr_tool_test() -> list:
  return tkr.ToolProxy

mytool = tkr.Tool(
  name="mytool",
  description="Simple tool example",
  version="0.0.1",
  method=tkr_tool_test
)

print(mytool.name, mytool(), mytool.version)

# Get tool by name
print(tkr.byname("mytool").id)
```
Getting code or content from git repo:
```python
import tkr
from tkr.ext import tests

# Defaults to test/README.md which provides info on the latest testing files.
driver: tests.Driver = tests.Driver(path='/abc/_tool.py', folder='tkr') 
print(driver)
```

# Links
- [Github](https://github.com/toolkitr/tkr)
- [PyPi](https://pypi.org/project/tkr)
- [Issues](https://github.com/toolkitr/tkr/issues)
- [Discussions](https://github.com/toolkitr/tkr/discussions)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/toolkitr/tkr",
    "name": "tkr",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10.0,<3.12",
    "maintainer_email": "",
    "keywords": "tkr,toolkitr",
    "author": "tlkr.",
    "author_email": "\"tlkr.\" <toolkitr.email@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e7/51/a21f7fe386f015e9a6020b6ed384959686c2fb0fca8f45a2e5014c195158/tkr-0.2.1.post1.tar.gz",
    "platform": null,
    "description": "<div id=\"header\">\n  <img src=\"https://i.ibb.co/P6fHtgc/tkr-social-preview.png\" width=\"500\"/>\n</div>\n\n# [TKR - Python Toolkit](https://pypi.org/project/tkr/)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toolkitr/tkr/blob/main/LICENSE)\n[![Python Versions](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20-blue)](https://www.python.org/downloads/)\n\n```Allow python developers to easily manage classes, methods, and more!```\n<p align=\"left\"> <a href=\"https://www.python.org\" target=\"_blank\" rel=\"noreferrer\"> <img src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg\" alt=\"python\" width=\"40\" height=\"40\"/></a></p>\n\n## Installing\n```shell\n# Linux/macOS\npython3 -m pip install -U tkr\n\n# Windows\npy -3 -m pip install -U tkr\n```\nDevelopment Version:\n```shell\n$ git clone https://github.com/toolkitr/tkr\n$ cd tkr\n```\n\n# Simple Examples\n```python\nimport tkr\n\ndef tkr_tool_test() -> list:\n  return tkr.ToolProxy\n\nmytool = tkr.Tool(\n  name=\"mytool\",\n  description=\"Simple tool example\",\n  version=\"0.0.1\",\n  method=tkr_tool_test\n)\n\nprint(mytool.name, mytool(), mytool.version)\n\n# Get tool by name\nprint(tkr.byname(\"mytool\").id)\n```\nGetting code or content from git repo:\n```python\nimport tkr\nfrom tkr.ext import tests\n\n# Defaults to test/README.md which provides info on the latest testing files.\ndriver: tests.Driver = tests.Driver(path='/abc/_tool.py', folder='tkr') \nprint(driver)\n```\n\n# Links\n- [Github](https://github.com/toolkitr/tkr)\n- [PyPi](https://pypi.org/project/tkr)\n- [Issues](https://github.com/toolkitr/tkr/issues)\n- [Discussions](https://github.com/toolkitr/tkr/discussions)\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2023 toolkitr  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Python Toolkit",
    "version": "0.2.1.post1",
    "project_urls": {
        "Discussions": "https://github.com/toolkitr/tkr/discussions",
        "Homepage": "https://github.com/toolkitr/tkr",
        "Issues": "https://github.com/toolkitr/tkr/issues",
        "PullRequest": "https://github.com/toolkitr/tkr/pulls"
    },
    "split_keywords": [
        "tkr",
        "toolkitr"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "030f89a83b544c3eabc046ceb0617f40de61395426e2aeef526ec8f41fe0b1c3",
                "md5": "54726da38da0ca4325de739beadf597c",
                "sha256": "515e3765e6a2a4f5498e5eeeae2d3aa945fb9d8971f6fa976c7139ddba80c563"
            },
            "downloads": -1,
            "filename": "tkr-0.2.1.post1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "54726da38da0ca4325de739beadf597c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0,<3.12",
            "size": 13339,
            "upload_time": "2023-11-18T09:26:21",
            "upload_time_iso_8601": "2023-11-18T09:26:21.637540Z",
            "url": "https://files.pythonhosted.org/packages/03/0f/89a83b544c3eabc046ceb0617f40de61395426e2aeef526ec8f41fe0b1c3/tkr-0.2.1.post1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e751a21f7fe386f015e9a6020b6ed384959686c2fb0fca8f45a2e5014c195158",
                "md5": "071f65589c4692a5e8070e67e0afabf2",
                "sha256": "1c51f98b528eee147ccd4e11fc53b78c707ecac72fa85263bc2bdc9b95a26be9"
            },
            "downloads": -1,
            "filename": "tkr-0.2.1.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "071f65589c4692a5e8070e67e0afabf2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0,<3.12",
            "size": 12205,
            "upload_time": "2023-11-18T09:26:24",
            "upload_time_iso_8601": "2023-11-18T09:26:24.004395Z",
            "url": "https://files.pythonhosted.org/packages/e7/51/a21f7fe386f015e9a6020b6ed384959686c2fb0fca8f45a2e5014c195158/tkr-0.2.1.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-18 09:26:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "toolkitr",
    "github_project": "tkr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "tkr"
}
        
Elapsed time: 0.19672s