# OVOS-utils
collection of simple utilities for use across the mycroft ecosystem
## Install
```bash
pip install ovos_utils
```
## Commandline scripts
### ovos-logs
Small helper tool to quickly navigate the logs, create slices and quickview errors
---------------
- **ovos-logs slice [options]**
**Slice logs of a given time period. Defaults on the last service start (`-s`) until now (`-u`)**
_Different logs can be picked using the `-l` option. All logs will be included if not specified._
_Optionally the directory where the logs are stored (`-p`) and the file where the slices should be dumped (`-f`) can be specified._
_[ex: `ovos-logs slice`]_
<sup>_Slice all logs from service start up until now._</sup>
_[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25`]_
<sup>_Slice all logs from 17:05:20 until 17:05:25._</sup>
<sup>_**no logs in that timeframe in other present logs_</sup>
<img width="1898" alt="Screenshot 2023-12-25 185004" src="https://github.com/emphasize/ovos-utils/assets/25036977/c7918bd6-0e13-46af-8016-55486b9a786e">
_[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25 -l skills`]_
<sup>_Slice skills.log from 17:05:20 until 17:05:25._</sup>
_[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25 -f ~/testslice.log`]_
<sup>_Slice the logs from 17:05:20 until 17:05:25 on all log files and dump the slices in the file ~/testslice.log (default: `~/slice_<timestamp>.log`)._</sup>
<img width="1246" alt="Screenshot 2023-12-25 190732" src="https://github.com/emphasize/ovos-utils/assets/25036977/dda99d8a-2739-4872-b81a-f44902b43d7d">
--------------
- **ovos-logs list [-e|-w|-d|-x] [options]**
**List logs by severity (error/warning/debug/exception). A log level has to be specified - more than one can be listed**
_A start and end date can be specified using the `-s` and `-u` options. Defaults to the last service start until now._
_Different logs can be picked using the `-l` option. All logs will be included if not specified._
_Optionally, the directory where the logs are stored (`-p`) and the file where the slices should be dumped (`-f`) can be passed as arguments._
_[ex: `ovos-logs list -x`]_
<sup>_List the logs with level EXCEPTION (plus tracebacks) from the last service start until now._</sup>
<img width="992" alt="Screenshot 2023-12-25 184321" src="https://github.com/emphasize/ovos-utils/assets/25036977/da8be23a-4268-4647-8dd3-32c1a889440c">
_[ex: `ovos-logs list -w -e -s 20-12-2023 -l bus -l skills`]_
<sup>_List the logs with level WARNING and ERROR from the 20th of December 2023 until now from the logs bus.log and skills.log._</sup>
<img width="1898" alt="Screenshot 2023-12-25 173739" src="https://github.com/emphasize/ovos-utils/assets/25036977/c5703195-4393-4989-ae40-b37638438c92">
---------------------
- **ovos-logs reduce [options]**
**Downsize logs to a given size (in bytes) or remove entries before a given date.**
_Different logs can be included using the `-l` option. If not specified, all logs will be included._
_Optionally the directory where the logs are stored (`-p`) can be specified._
_[ex: `ovos-logs reduce`]_
<sup>_Downsize all logs to 0 bytes_</sup>
_[ex: `ovos-logs reduce -s 1000000`]_
<sup>_Downsize all logs to ~1MB (latest logs)_</sup>
_[ex: `ovos-logs reduce -d "1-12-2023 17:00"`]_
<sup>_Downsize all logs to entries after the specified date/time_</sup>
_[ex: `ovos-logs reduce -s 1000000 -l skills -l bus`]_
<sup>_Downsize skills.log and bus.log to ~1MB (latest logs)_</sup>
---------------------
- **ovos-logs show -l [servicelog]**
**Show logs**
_[ex: `ovos-logs show -l bus`]_
<sup>_Show the logs from bus.log._</sup>
_[ex: wrong servicelog]_
<sup>_**logs shown depending on the logs present in the folder_</sup>
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/ovos_utils",
"name": "ovos-utils",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "jarbasAI",
"author_email": "jarbas@openvoiceos.com",
"download_url": "https://files.pythonhosted.org/packages/3b/69/82d13a523319f3f4d981a95bd129e20b84a436c305d833b6864ec0443aac/ovos_utils-0.5.4.tar.gz",
"platform": null,
"description": "# OVOS-utils\n\ncollection of simple utilities for use across the mycroft ecosystem\n\n## Install\n\n```bash\npip install ovos_utils\n```\n\n## Commandline scripts\n### ovos-logs\n Small helper tool to quickly navigate the logs, create slices and quickview errors \n\n---------------\n- **ovos-logs slice [options]**\n\n **Slice logs of a given time period. Defaults on the last service start (`-s`) until now (`-u`)**\n\n _Different logs can be picked using the `-l` option. All logs will be included if not specified._ \n _Optionally the directory where the logs are stored (`-p`) and the file where the slices should be dumped (`-f`) can be specified._\n\n\n _[ex: `ovos-logs slice`]_ \n <sup>_Slice all logs from service start up until now._</sup>\n\n _[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25`]_ \n <sup>_Slice all logs from 17:05:20 until 17:05:25._</sup> \n <sup>_**no logs in that timeframe in other present logs_</sup>\n <img width=\"1898\" alt=\"Screenshot 2023-12-25 185004\" src=\"https://github.com/emphasize/ovos-utils/assets/25036977/c7918bd6-0e13-46af-8016-55486b9a786e\"> \n\n _[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25 -l skills`]_ \n <sup>_Slice skills.log from 17:05:20 until 17:05:25._</sup>\n\n _[ex: `ovos-logs slice -s 17:05:20 -u 17:05:25 -f ~/testslice.log`]_ \n <sup>_Slice the logs from 17:05:20 until 17:05:25 on all log files and dump the slices in the file ~/testslice.log (default: `~/slice_<timestamp>.log`)._</sup>\n <img width=\"1246\" alt=\"Screenshot 2023-12-25 190732\" src=\"https://github.com/emphasize/ovos-utils/assets/25036977/dda99d8a-2739-4872-b81a-f44902b43d7d\">\n--------------\n\n- **ovos-logs list [-e|-w|-d|-x] [options]**\n\n **List logs by severity (error/warning/debug/exception). A log level has to be specified - more than one can be listed** \n\n _A start and end date can be specified using the `-s` and `-u` options. Defaults to the last service start until now._ \n _Different logs can be picked using the `-l` option. All logs will be included if not specified._ \n _Optionally, the directory where the logs are stored (`-p`) and the file where the slices should be dumped (`-f`) can be passed as arguments._ \n\n _[ex: `ovos-logs list -x`]_ \n <sup>_List the logs with level EXCEPTION (plus tracebacks) from the last service start until now._</sup>\n <img width=\"992\" alt=\"Screenshot 2023-12-25 184321\" src=\"https://github.com/emphasize/ovos-utils/assets/25036977/da8be23a-4268-4647-8dd3-32c1a889440c\">\n\n _[ex: `ovos-logs list -w -e -s 20-12-2023 -l bus -l skills`]_ \n <sup>_List the logs with level WARNING and ERROR from the 20th of December 2023 until now from the logs bus.log and skills.log._</sup>\n <img width=\"1898\" alt=\"Screenshot 2023-12-25 173739\" src=\"https://github.com/emphasize/ovos-utils/assets/25036977/c5703195-4393-4989-ae40-b37638438c92\">\n---------------------\n\n- **ovos-logs reduce [options]**\n\n **Downsize logs to a given size (in bytes) or remove entries before a given date.** \n\n _Different logs can be included using the `-l` option. If not specified, all logs will be included._ \n _Optionally the directory where the logs are stored (`-p`) can be specified._ \n\n _[ex: `ovos-logs reduce`]_ \n <sup>_Downsize all logs to 0 bytes_</sup> \n\n _[ex: `ovos-logs reduce -s 1000000`]_ \n <sup>_Downsize all logs to ~1MB (latest logs)_</sup> \n\n _[ex: `ovos-logs reduce -d \"1-12-2023 17:00\"`]_ \n <sup>_Downsize all logs to entries after the specified date/time_</sup> \n\n _[ex: `ovos-logs reduce -s 1000000 -l skills -l bus`]_ \n <sup>_Downsize skills.log and bus.log to ~1MB (latest logs)_</sup> \n\n---------------------\n\n- **ovos-logs show -l [servicelog]**\n\n **Show logs**\n\n _[ex: `ovos-logs show -l bus`]_ \n <sup>_Show the logs from bus.log._</sup> \n\n _[ex: wrong servicelog]_ \n <sup>_**logs shown depending on the logs present in the folder_</sup>\n\n\n\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "collection of simple utilities for use across the openvoiceos ecosystem",
"version": "0.5.4",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/ovos_utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb1e975df710784d0236584aae8f77d505fbd18fc864867a9e64153fbaef62a6",
"md5": "817c25ce93bc9ca239fce3133e20e6f9",
"sha256": "1a98b623b6f8523516a6845b3bfe9ea4068656c8c17505865e6daf1d2ee4b4c9"
},
"downloads": -1,
"filename": "ovos_utils-0.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "817c25ce93bc9ca239fce3133e20e6f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 76003,
"upload_time": "2024-11-21T19:39:10",
"upload_time_iso_8601": "2024-11-21T19:39:10.347048Z",
"url": "https://files.pythonhosted.org/packages/eb/1e/975df710784d0236584aae8f77d505fbd18fc864867a9e64153fbaef62a6/ovos_utils-0.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b6982d13a523319f3f4d981a95bd129e20b84a436c305d833b6864ec0443aac",
"md5": "7c70f5c3a3842079b96cbfde646e5aca",
"sha256": "58e79ee86689a0a66c969cbc85dde4c26ec40be9b0882d3a4d782a925b9bfae6"
},
"downloads": -1,
"filename": "ovos_utils-0.5.4.tar.gz",
"has_sig": false,
"md5_digest": "7c70f5c3a3842079b96cbfde646e5aca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68249,
"upload_time": "2024-11-21T19:39:11",
"upload_time_iso_8601": "2024-11-21T19:39:11.459490Z",
"url": "https://files.pythonhosted.org/packages/3b/69/82d13a523319f3f4d981a95bd129e20b84a436c305d833b6864ec0443aac/ovos_utils-0.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 19:39:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "ovos_utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ovos-utils"
}
JSON
