# toolboks
toolboks is a lightweight utility library.
## Installation
Install with pip:
`pip install toolboks`
## Usage
Most functions are available by simply importing toolboks directly:
```
> import toolboks as tb
> nested_list = [1,2,3,[4,5,[6,7,8]]]
> tb.expand(nested_list, depth=1)
[1, 2, 3, 4, 5, [6, 7, 8]]
```
Modules can also be imported separately:
```
from toolboks import xdg
# get user base dirs according to the XDG base directory specification
base_dirs = xdg.base_dirs()
```
## Module Overview
| Module | Description | Classes | Functions |
|-----------|---------------------------------|---------|-----------------|
| config | Configuration file functions | | read_config |
| listlib | List manipulation & helpers | | expand, flatten |
| modifiers | Common data modifiers | | filter_abs_path |
| system | Common system related functions | | context, getenv |
| xdg | Functions for XDG base dirs | | base_dirs, cache_home, config_dirs, config_home,<br> data_dirs, data_home, runtime_dir, state_home,<br> user_dirs, user_home |
## Command Line Interface
toolboks has a command line interface with shell commands for relevant functions from the toolboks library.
It is available as a separate package: [toolboks-cli](https://pypi.org/project/toolboks-cli/)
Install it with pip:
`pip install toolboks-cli`
See documentation of toolboks-cli for more information on available commands.
## License
GPL-3.0-only
Raw data
{
"_id": null,
"home_page": "",
"name": "toolboks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "utility,developer tools,library,CLI tools",
"author": "Mikael Tranbom",
"author_email": "mikael@tranbom.io",
"download_url": "https://files.pythonhosted.org/packages/af/c4/93895b6c55ad6a40cc1125d327f32d2e1905a9e77a0722ecdde4da5c7727/toolboks-0.0.2.tar.gz",
"platform": null,
"description": "# toolboks\n\ntoolboks is a lightweight utility library.\n\n\n## Installation\n\nInstall with pip:\n\n`pip install toolboks`\n\n\n## Usage\n\nMost functions are available by simply importing toolboks directly:\n\n```\n> import toolboks as tb\n\n> nested_list = [1,2,3,[4,5,[6,7,8]]]\n> tb.expand(nested_list, depth=1)\n[1, 2, 3, 4, 5, [6, 7, 8]]\n```\n\n\nModules can also be imported separately:\n\n```\nfrom toolboks import xdg\n\n# get user base dirs according to the XDG base directory specification\nbase_dirs = xdg.base_dirs()\n```\n\n## Module Overview\n\n| Module | Description | Classes | Functions |\n|-----------|---------------------------------|---------|-----------------|\n| config | Configuration file functions | | read_config |\n| listlib | List manipulation & helpers | | expand, flatten |\n| modifiers | Common data modifiers | | filter_abs_path |\n| system | Common system related functions | | context, getenv |\n| xdg | Functions for XDG base dirs | | base_dirs, cache_home, config_dirs, config_home,<br> data_dirs, data_home, runtime_dir, state_home,<br> user_dirs, user_home |\n\n\n## Command Line Interface\ntoolboks has a command line interface with shell commands for relevant functions from the toolboks library. \nIt is available as a separate package: [toolboks-cli](https://pypi.org/project/toolboks-cli/)\n\nInstall it with pip:\n`pip install toolboks-cli`\n\nSee documentation of toolboks-cli for more information on available commands.\n\n\n## License\n\nGPL-3.0-only\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "toolboks utility library",
"version": "0.0.2",
"split_keywords": [
"utility",
"developer tools",
"library",
"cli tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4103daa83c5ad2a82d03695fd5c8d2f7",
"sha256": "7ff6079da8c60117517dddee4319142d39cf7e0140cff0f1b7d8bf8243126a7c"
},
"downloads": -1,
"filename": "toolboks-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4103daa83c5ad2a82d03695fd5c8d2f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21409,
"upload_time": "2022-12-28T16:38:38",
"upload_time_iso_8601": "2022-12-28T16:38:38.312612Z",
"url": "https://files.pythonhosted.org/packages/cc/fb/0d28f2ba1e6c6062cd5bcc579333f6135374713bd7443107611ff4e7f941/toolboks-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c708a059ed7d7055a5dc9bf8796338d2",
"sha256": "882cba6a353ed45040a07c1a891b3040eb75748c5c28d904d1bed3681c5e91d1"
},
"downloads": -1,
"filename": "toolboks-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c708a059ed7d7055a5dc9bf8796338d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 18513,
"upload_time": "2022-12-28T16:38:39",
"upload_time_iso_8601": "2022-12-28T16:38:39.780210Z",
"url": "https://files.pythonhosted.org/packages/af/c4/93895b6c55ad6a40cc1125d327f32d2e1905a9e77a0722ecdde4da5c7727/toolboks-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-28 16:38:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "toolboks"
}
JSON