semvec/pypi-packages huggingface dataset:
tp-timesheet 2.1.1
CLI tool to automate the submisison of tp timesheets
License: MIT
Requires Python: >=3.8
Keywords: automation,timesheet,cli,executable

# TP-Timesheet
[![Build Status](https://jenkins.thorpe.work/buildStatus/icon?job=tp-timesheet%2Fmain&subject=build%20status)](https://jenkins.thorpe.work/blue/organizations/jenkins/tp-timesheet/activity)
[![PyPI version](https://img.shields.io/pypi/v/tp-timesheet.svg)](https://pypi.org/project/tp-timesheet/)
[![PyPI license](https://img.shields.io/pypi/l/tp-timesheet.svg)](https://pypi.org/project/tp-timesheet/)

Automated submission of TP timesheets.

* Version 0.x.x is web form only
* Version 1.x.x is web + Clockify
* Version 2.x.x is Clockify only

## Installation
### Install
This tool is published on pypi so from any terminal with python3 installed run:

```bash
pip install tp-timesheet
```
**Note:** some outdated OS's still require pip3 instead of pip. If you get an error `Unknown command: pip` then try the following:
```bash
pip3 install tp-timesheet
```
### Upgrade
```bash
pip install --upgrade tp-timesheet
```
### Uninstall
```bash
pip uninstall tp-timesheet
```
## Usage

Run the tool with the help option to find out additional usage information

```bash
tp-timesheet --help
```

### Common cli options

```bash
# submit live hours (default) for today
tp-timesheet --start today

# submit live hours (default) for next 5 days
tp-timesheet --start today --count 5

# submit for Mon 3/10/22 to Thursday 6/10/22 with a task of Out Of Office (OOO)
tp-timesheet --start '3/10/22' --count 5 -t OOO

# Schedule the form to submit automatically on weekdays
tp-timesheet --automate weekdays

# append '--verbose' to any command to get more log messages about what is going on
# append '--dry-run' to any command to avoid clicking submit. Good for testing
```

## Development
Install the dev environment and run tool locally:

```bash
pip install -e .[dev]

tp-timesheet --help
```

note: if zsh is used, install the dev environment with:
```bash
pip install -e ".[dev]"
```
### Contributing 
To run checks prior to committing

```bash
black --check --diff tp_timesheet # See what formatting changes need to be made
black tp_timesheet # Run formatter
pylint tp_timesheet # Run linter
pytest # Run testing
```