Skip to main content

Python Toolkit

Project description

TKR - Python Toolkit

## tkr

License Python Versions

## Description

TKR is a Python package that allows for you to save functions to assigned 'Tools' with names, versions, descriptions, etc. Easily keep track of global tools and get a specific tool by name or method.

## Features

- tkr.Tool: Primary class of tkr (tkr.abc.Tool). Protocol tkr.abc._tool.ToolProxy
- tkr.ToolProxy: Protocol method for all Tools, allows users to create their own versions of Tools with ToolProxy.
- tkr.core: tkr's core/parent to methods and processing.

## Installation

You can install `tkr` using pip:
pip install tkr

Usage

To use the tkr package, first import it into your Python script:

import tkr

Next, you can call the functions and utilities provided by the package. Here's an example:

import tkr

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

mytool = tkr.Tool(
  name="mytool",
  version="0.0.1",
  method=tkr_tool_test
)

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

For more detailed examples and usage instructions, please refer to the documentation.

Contributing

Contributions are welcome! If you find a bug or want to suggest a new feature, please open an issue or submit a pull request. Make sure to read the contribution guidelines before getting started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distribution

tkr-0.1.7.3.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

tkr-0.1.7.3-py3-none-any.whl (8.3 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