# Clocky
Clocky is a pseudo-port of GNU Time, written in Python. The output generally looks like `time`.
Certain format codes may not work exactly like they do in GNU `time`.
# Installation
This will install the clocky cli:
```
pip install clocky
```
# Usage
Clocky can be run via `clocky` or `python -m clocky`
<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./help_output.txt) -->
<!-- The below code snippet is automatically added from ./help_output.txt -->
```txt
usage: clocky [-h] [-p] [-o OUTPUT] [-f FORMAT] [-a] [-v] [-q] [-V] [-g] ...
A pseudo-port of GNU time to Python. You can look at the man page of time to
get some info about the args here. Certain format codes are not supported and
will return a ? in place of an actual value.
positional arguments:
cmd The command to time.
options:
-h, --help show this help message and exit
-p Use the portable output format.
-o OUTPUT, --output OUTPUT
Do not send the results to stderr, but overwrite the
specified file.
-f FORMAT, --format FORMAT
Specify output format, possibly overriding the format
specified in the environment variable TIME.
-a, --append (Used together with -o.) Do not overwrite but append.
-v, --verbose Give very verbose output about all the program knows
about.
-q, --quiet Don't report abnormal program termination (where
command is terminated by a signal) or nonzero exit
status.
-V, --version Print version information on standard output, then
exit successfully.
-g A clocky-specific extension. When set, tries to act
similar to gnu time in terms of output. Otherwise by
default (without -f) clocky acts like bash's time
command.
```
<!-- MARKDOWN-AUTO-DOCS:END -->
# Simple Example
Clocky can be used to time function execution (just like the time command):
```
> clocky echo "Hello World"
Hello World
real 0m0.007s
user 0m0.000s
sys 0m0.000s
```
Raw data
{
"_id": null,
"home_page": "http://github.com/csm10495/clocky",
"name": "clocky",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "csm10495",
"author_email": "csm10495@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f3/20/b08ff0989c0c83302df2a9544ac712fa30fc48baf314d6d3ef108aef742d/clocky-0.0.7.tar.gz",
"platform": null,
"description": "# Clocky\n\nClocky is a pseudo-port of GNU Time, written in Python. The output generally looks like `time`.\n\nCertain format codes may not work exactly like they do in GNU `time`.\n\n# Installation\n\nThis will install the clocky cli:\n\n```\npip install clocky\n```\n\n# Usage\n\nClocky can be run via `clocky` or `python -m clocky`\n\n<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./help_output.txt) -->\n<!-- The below code snippet is automatically added from ./help_output.txt -->\n```txt\nusage: clocky [-h] [-p] [-o OUTPUT] [-f FORMAT] [-a] [-v] [-q] [-V] [-g] ...\n\nA pseudo-port of GNU time to Python. You can look at the man page of time to\nget some info about the args here. Certain format codes are not supported and\nwill return a ? in place of an actual value.\n\npositional arguments:\n cmd The command to time.\n\noptions:\n -h, --help show this help message and exit\n -p Use the portable output format.\n -o OUTPUT, --output OUTPUT\n Do not send the results to stderr, but overwrite the\n specified file.\n -f FORMAT, --format FORMAT\n Specify output format, possibly overriding the format\n specified in the environment variable TIME.\n -a, --append (Used together with -o.) Do not overwrite but append.\n -v, --verbose Give very verbose output about all the program knows\n about.\n -q, --quiet Don't report abnormal program termination (where\n command is terminated by a signal) or nonzero exit\n status.\n -V, --version Print version information on standard output, then\n exit successfully.\n -g A clocky-specific extension. When set, tries to act\n similar to gnu time in terms of output. Otherwise by\n default (without -f) clocky acts like bash's time\n command.\n```\n<!-- MARKDOWN-AUTO-DOCS:END -->\n\n# Simple Example\n\nClocky can be used to time function execution (just like the time command):\n\n```\n> clocky echo \"Hello World\"\nHello World\n\nreal 0m0.007s\nuser 0m0.000s\nsys 0m0.000s\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "",
"version": "0.0.7",
"project_urls": {
"Homepage": "http://github.com/csm10495/clocky"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f873764e22df4e0811b4af1d3add4b66c836d2ebd438a9e5ddaaa046241783d",
"md5": "7de652cc580f85776739bab192614258",
"sha256": "0f81b4f33407e41aa808a0e11ea589a55f9db4ed781fe5a501a33de1752d8fe0"
},
"downloads": -1,
"filename": "clocky-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7de652cc580f85776739bab192614258",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7827,
"upload_time": "2023-06-07T03:57:49",
"upload_time_iso_8601": "2023-06-07T03:57:49.979538Z",
"url": "https://files.pythonhosted.org/packages/4f/87/3764e22df4e0811b4af1d3add4b66c836d2ebd438a9e5ddaaa046241783d/clocky-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f320b08ff0989c0c83302df2a9544ac712fa30fc48baf314d6d3ef108aef742d",
"md5": "bfad04fc2e81e26fdf7b5232226df910",
"sha256": "f13cf3313386a496837d4e8fe492060f878a2efa3b62a589a090a776a2d66fd8"
},
"downloads": -1,
"filename": "clocky-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "bfad04fc2e81e26fdf7b5232226df910",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7153,
"upload_time": "2023-06-07T03:57:51",
"upload_time_iso_8601": "2023-06-07T03:57:51.411035Z",
"url": "https://files.pythonhosted.org/packages/f3/20/b08ff0989c0c83302df2a9544ac712fa30fc48baf314d6d3ef108aef742d/clocky-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-07 03:57:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csm10495",
"github_project": "clocky",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clocky"
}
JSON
