Metadata-Version: 2.1
Name: jira-timesheet-cli
Version: 0.1.1a2
Summary: A cli utility to book time in jira
License: MIT
Author: Yannick Habecker
Author-email: dev@y2g.de
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Description-Content-Type: text/markdown

# jira-timetracking-cli

This tool can be used to book times into JIRA issues. This tool uses the internal rest api (v3) of JIRA and therefore can be subject to change. Use it on your own risk!

## Installation

Create new virtualenv `virtualenv ./venv`, activate it `source venv/bin/activate` install all requirements `pip install -r requirements.txt`. Then build the project using `pyinstaller book-time.spec`. Add `dist/book-time` to your `$PATH` and use it.

## Usage

Before using the tool you need to specify the following environment variables:
- JIRA_URL: The jira base url. Eg. `https://jira.test.com/`
- JIRA_USER: Your JIRA user (eg. email address)
- JIRA_TOKEN: Your API access token 

See help for more information about the arguments: `book-time -help`. Examples:
```
book-time -yesterday -ticket ABC-1234 -duration 3h15m -at 12:45
book-time -today -ticket ABC-1234 -duration 3h15m -at 12:45
book-time -ticket ABC-1234 -duration 3h15m -date 28-10-22 -now
book-time -ticket ABC-1234 -duration 3h15m -date 28-10-22 -at 12:45
```

If you don't want to set a specific time and instead always book at the same time, you can just use an alias:
```
alias book-time='book-time -at 10:00'
```

## Completion

`source <(book-time completion)`

