log-time-to-tempo


Namelog-time-to-tempo JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryLog your work time to tempo from the command line.
upload_time2024-04-17 17:21:23
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseISC 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

[![PyPI - Version](https://img.shields.io/pypi/v/log-time-to-tempo.svg)](https://pypi.org/project/log-time-to-tempo)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/log-time-to-tempo.svg)](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

```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
```

## 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_FROM_TIME 10

# Remove all custom configuration
lt config --unset
```

## Changes

### [latest] - 2024-XX-XX
[latest]: https://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/main/README.md

### [0.0.2] - 2024-04-17
[0.0.2]: https://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/0.0.2/README.md

- 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://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/0.0.1/README.md

- 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/

            

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/f3/d5/d89555b16cd33a50b8471e86266c2d24aa5fef9d69bde7e3ee3b623f811f/log_time_to_tempo-0.0.2.tar.gz",
    "platform": null,
    "description": "# Log Time to Tempo\n\n[![PyPI - Version](https://img.shields.io/pypi/v/log-time-to-tempo.svg)](https://pypi.org/project/log-time-to-tempo)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/log-time-to-tempo.svg)](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```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```\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_FROM_TIME 10\n\n# Remove all custom configuration\nlt config --unset\n```\n\n## Changes\n\n### [latest] - 2024-XX-XX\n[latest]: https://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/main/README.md\n\n### [0.0.2] - 2024-04-17\n[0.0.2]: https://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/0.0.2/README.md\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://gitlab.codecentric.de/jmm/log-time-to-tempo/-/blob/0.0.1/README.md\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",
    "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.2",
    "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": "5509b857a9a55e7855495c57cc9ce2a661fd79df3dbcf74e01c5297b340d5ac9",
                "md5": "1f34184b1fef654be4ccac1cb5140478",
                "sha256": "d6a926d29a8994eb3c571919f29009d73bf5fa820782b40d3a472cc2564abafb"
            },
            "downloads": -1,
            "filename": "log_time_to_tempo-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f34184b1fef654be4ccac1cb5140478",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15378,
            "upload_time": "2024-04-17T17:21:25",
            "upload_time_iso_8601": "2024-04-17T17:21:25.134916Z",
            "url": "https://files.pythonhosted.org/packages/55/09/b857a9a55e7855495c57cc9ce2a661fd79df3dbcf74e01c5297b340d5ac9/log_time_to_tempo-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f3d5d89555b16cd33a50b8471e86266c2d24aa5fef9d69bde7e3ee3b623f811f",
                "md5": "3026b40e8f8bb699003b13473d79b6f2",
                "sha256": "f212296d27758ddf082c39fc271eddd6294c87bf5ede3eec4b8d98dddf5f3052"
            },
            "downloads": -1,
            "filename": "log_time_to_tempo-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3026b40e8f8bb699003b13473d79b6f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 694879,
            "upload_time": "2024-04-17T17:21:23",
            "upload_time_iso_8601": "2024-04-17T17:21:23.824381Z",
            "url": "https://files.pythonhosted.org/packages/f3/d5/d89555b16cd33a50b8471e86266c2d24aa5fef9d69bde7e3ee3b623f811f/log_time_to_tempo-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 17:21:23",
    "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"
}
        
Elapsed time: 0.32613s