| Name | log-time-to-tempo JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Log your work time to tempo from the command line. |
| upload_time | 2024-09-12 10:43:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | ISC License
Copyright (c) 2024 Jannis Mainczyk <jannis.mainczyk@codecentric.de>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. |
| keywords |
cli
jira
tempo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Log Time to Tempo
[](https://pypi.org/project/log-time-to-tempo)
[](https://pypi.org/project/log-time-to-tempo)
-----
Log your time to tempo on a self-hosted Jira instance from the convenience of your command line.
## Requirements
This tool is developed against
- Jira Server v9.4.17
- Tempo Timesheets 17.2.0 plugin
Any deviation from that setup might lead to issues.
Feel free to provide PRs to support other configurations.
## Installation
```console
pip install log-time-to-tempo
```
## Getting Started
To initialize authentication and local caches of projects and issues, run
```
lt init
```
If you want to enable shell completion (which makes picking issues much easier), run
```
lt --install-completion
```
## Usage
### Log Time
```sh
# log full workday to default issue
lt log
# log 2h to default issue
lt log 2h
# log 2h to specific issue
lt log 2h TSI-1
# log with custom message
lt log -m "working on foo" 2h TSI-1
```
### Check Logged Time
```sh
# show logged time per issue
lt stats
# show logged time per issue for current month
lt stats month
# ..also show individual worklogs
lt stats -v
```
## Configuration
The `lt config` command allows to change the default behavior, either system wide (`--system`) or in the local directory and subdirectories.
Here are a couple of usage examples:
```sh
# Set custom jira instance for all projects (i.e. system-wide)
lt config --system JIRA_INSTANCE https://jira.my-server.com
# Set default issue for worklogs created from current directory (and subdirectories)
lt config LT_LOG_ISSUE TSI-7
# Start all your worklogs at 10am (instead of the default 9am)
lt config --system LT_LOG_START 10
# Remove all custom configuration
lt config --unset
```
## Changes
### [latest]
[latest]: https://github.com/jannismain/log-time-to-tempo/commits/main/
<!-- ### [0.0.X] - 202X-XX-XX
[0.0.3]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.X -->
### [0.0.3] - 2024-09-12
[0.0.3]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.3
- add `lt stats` command to aggregate spent time per issue
- add `lt alias` command to provide more meaningful aliases for issue descriptions
- `lt alias --unset` to remove previously set aliases
- renamed relative date ranges
- `week` → `last_7_days`
- `month` → `last_30_days`
- `week_to_date` → `week`
- `month_to_date` → `month`
- support abbreviations for relative date ranges (e.g. `l7` for `last_7_days`)
- fix issue where app dir would not be created on first run
- fix issue with formatted durations, where days would not be accounted for
- fix issue where token was saved to third-party keyrings (e.g. 1Password)
- parse more relative dates (e.g. "3 weeks ago") (using [`dateparser.parse`][dateparser.parse])
### [0.0.2] - 2024-04-17
[0.0.2]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.2
- add `log --lunch` option to reduce the amount of math you have to do in your head when entering your time
- lunch will simply be deducted from the total duration and your end time
- rename `log --from-time '' --to-time ''` options to `log --start '' --end ''`
- `log --day` is now case-insensitive (so `Mo` will be recognized as `monday`)
- add `--version` flag
### [0.0.1] - 2024-03-25
[0.0.1]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.1
- authorize with JIRA instance using personal access token
- prompt for token and persist using [`keyring`][python-keyring] package
- create and list worklogs via tempo's REST API
- list projects and issues using [`jira`][python-jira] API
- cache projects and issues for faster responses and shell completion
[python-jira]: https://github.com/pycontribs/jira
[python-keyring]: https://pypi.org/project/keyring/
[dateparser.parse]: https://dateparser.readthedocs.io/en/latest/#popular-formats
Raw data
{
"_id": null,
"home_page": null,
"name": "log-time-to-tempo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, jira, tempo",
"author": null,
"author_email": "Jannis Mainczyk <jannis.mainczyk@codecentric.de>",
"download_url": "https://files.pythonhosted.org/packages/89/6d/6e8d2dcf407acb7c54ee52dbcd60c47db709859c4769dfdc8327b023d8f9/log_time_to_tempo-0.0.3.tar.gz",
"platform": null,
"description": "# Log Time to Tempo\n\n[](https://pypi.org/project/log-time-to-tempo)\n[](https://pypi.org/project/log-time-to-tempo)\n\n-----\n\nLog your time to tempo on a self-hosted Jira instance from the convenience of your command line.\n\n## Requirements\n\nThis tool is developed against\n\n- Jira Server v9.4.17\n- Tempo Timesheets 17.2.0 plugin\n\nAny deviation from that setup might lead to issues.\nFeel free to provide PRs to support other configurations.\n\n## Installation\n\n```console\npip install log-time-to-tempo\n```\n\n## Getting Started\n\nTo initialize authentication and local caches of projects and issues, run\n\n```\nlt init\n```\n\nIf you want to enable shell completion (which makes picking issues much easier), run\n\n```\nlt --install-completion\n```\n\n## Usage\n\n### Log Time\n\n```sh\n# log full workday to default issue\nlt log\n# log 2h to default issue\nlt log 2h\n# log 2h to specific issue\nlt log 2h TSI-1\n# log with custom message\nlt log -m \"working on foo\" 2h TSI-1\n```\n\n### Check Logged Time\n\n```sh\n# show logged time per issue\nlt stats\n# show logged time per issue for current month\nlt stats month\n# ..also show individual worklogs\nlt stats -v\n```\n\n## Configuration\n\n\nThe `lt config` command allows to change the default behavior, either system wide (`--system`) or in the local directory and subdirectories.\n\nHere are a couple of usage examples:\n\n```sh\n# Set custom jira instance for all projects (i.e. system-wide)\nlt config --system JIRA_INSTANCE https://jira.my-server.com\n\n# Set default issue for worklogs created from current directory (and subdirectories)\nlt config LT_LOG_ISSUE TSI-7\n\n# Start all your worklogs at 10am (instead of the default 9am)\nlt config --system LT_LOG_START 10\n\n# Remove all custom configuration\nlt config --unset\n```\n\n## Changes\n\n### [latest]\n[latest]: https://github.com/jannismain/log-time-to-tempo/commits/main/\n\n<!-- ### [0.0.X] - 202X-XX-XX\n[0.0.3]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.X -->\n\n\n### [0.0.3] - 2024-09-12\n[0.0.3]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.3\n\n- add `lt stats` command to aggregate spent time per issue\n- add `lt alias` command to provide more meaningful aliases for issue descriptions\n - `lt alias --unset` to remove previously set aliases\n- renamed relative date ranges\n - `week` \u2192 `last_7_days`\n - `month` \u2192 `last_30_days`\n - `week_to_date` \u2192 `week`\n - `month_to_date` \u2192 `month`\n- support abbreviations for relative date ranges (e.g. `l7` for `last_7_days`)\n- fix issue where app dir would not be created on first run\n- fix issue with formatted durations, where days would not be accounted for\n- fix issue where token was saved to third-party keyrings (e.g. 1Password)\n- parse more relative dates (e.g. \"3 weeks ago\") (using [`dateparser.parse`][dateparser.parse])\n\n### [0.0.2] - 2024-04-17\n[0.0.2]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.2\n\n- add `log --lunch` option to reduce the amount of math you have to do in your head when entering your time\n - lunch will simply be deducted from the total duration and your end time\n- rename `log --from-time '' --to-time ''` options to `log --start '' --end ''`\n- `log --day` is now case-insensitive (so `Mo` will be recognized as `monday`)\n- add `--version` flag\n\n### [0.0.1] - 2024-03-25\n[0.0.1]: https://github.com/jannismain/log-time-to-tempo/releases/tag/v0.0.1\n\n- authorize with JIRA instance using personal access token\n - prompt for token and persist using [`keyring`][python-keyring] package\n- create and list worklogs via tempo's REST API\n- list projects and issues using [`jira`][python-jira] API\n- cache projects and issues for faster responses and shell completion\n\n[python-jira]: https://github.com/pycontribs/jira\n[python-keyring]: https://pypi.org/project/keyring/\n[dateparser.parse]: https://dateparser.readthedocs.io/en/latest/#popular-formats\n",
"bugtrack_url": null,
"license": "ISC License\n \n Copyright (c) 2024 Jannis Mainczyk <jannis.mainczyk@codecentric.de>\n \n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\n REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\n AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\n INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\n LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\n OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\n PERFORMANCE OF THIS SOFTWARE.",
"summary": "Log your work time to tempo from the command line.",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://github.com/jannismain/log-time-to-tempo#readme",
"Issues": "https://github.com/jannismain/log-time-to-tempo/issues",
"Source": "https://github.com/jannismain/log-time-to-tempo"
},
"split_keywords": [
"cli",
" jira",
" tempo"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3d9456837c37c82a41101f982d35fe89d859a7639a2825322a9e0b861dc382a9",
"md5": "9b6c41b1234811b28cd1bf600300be29",
"sha256": "ae560735bc31d38a4bacabbad67ac9a20de23428515359e917d7bb555e3d5c13"
},
"downloads": -1,
"filename": "log_time_to_tempo-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b6c41b1234811b28cd1bf600300be29",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18503,
"upload_time": "2024-09-12T10:43:49",
"upload_time_iso_8601": "2024-09-12T10:43:49.996999Z",
"url": "https://files.pythonhosted.org/packages/3d/94/56837c37c82a41101f982d35fe89d859a7639a2825322a9e0b861dc382a9/log_time_to_tempo-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "896d6e8d2dcf407acb7c54ee52dbcd60c47db709859c4769dfdc8327b023d8f9",
"md5": "53a76a384d7db1183ff5b7c296fd9a06",
"sha256": "f736ff636e04a622a74a05e7dfa9b8fc9d9350616ef33f76cce8434c151044f6"
},
"downloads": -1,
"filename": "log_time_to_tempo-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "53a76a384d7db1183ff5b7c296fd9a06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 697595,
"upload_time": "2024-09-12T10:43:51",
"upload_time_iso_8601": "2024-09-12T10:43:51.846619Z",
"url": "https://files.pythonhosted.org/packages/89/6d/6e8d2dcf407acb7c54ee52dbcd60c47db709859c4769dfdc8327b023d8f9/log_time_to_tempo-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 10:43:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jannismain",
"github_project": "log-time-to-tempo#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "log-time-to-tempo"
}
