Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thorpejosh/tp-timesheet
Automated submission of timesheet
https://github.com/thorpejosh/tp-timesheet
Last synced: about 2 months ago
JSON representation
Automated submission of timesheet
- Host: GitHub
- URL: https://github.com/thorpejosh/tp-timesheet
- Owner: ThorpeJosh
- License: mit
- Created: 2022-09-23T02:29:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-21T05:41:22.000Z (over 1 year ago)
- Last Synced: 2024-11-02T12:42:40.518Z (2 months ago)
- Language: Python
- Homepage:
- Size: 148 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TP-Timesheet
[](https://jenkins.thorpe.work/blue/organizations/jenkins/tp-timesheet/activity)
[](https://pypi.org/project/tp-timesheet/)
[](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
```