tp-timesheet


Nametp-timesheet JSON
Version 2.1.1 PyPI version JSON
download
home_pagehttps://github.com/ThorpeJosh/tp-timesheet
SummaryCLI tool to automate the submisison of tp timesheets
upload_time2023-08-21 04:26:37
maintainer
docs_urlNone
authorJoshua Thorpe
requires_python>=3.8
licenseMIT
keywords automation timesheet cli executable
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ThorpeJosh/tp-timesheet",
    "name": "tp-timesheet",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "automation,timesheet,cli,executable",
    "author": "Joshua Thorpe",
    "author_email": "josh@thorpe.engineering",
    "download_url": "https://files.pythonhosted.org/packages/bd/86/8be3d257ad13fb5fbef99ce44ad3e7b2f677d9c60f6828bde85c36e343a5/tp-timesheet-2.1.1.tar.gz",
    "platform": null,
    "description": "# TP-Timesheet\n[![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)\n[![PyPI version](https://img.shields.io/pypi/v/tp-timesheet.svg)](https://pypi.org/project/tp-timesheet/)\n[![PyPI license](https://img.shields.io/pypi/l/tp-timesheet.svg)](https://pypi.org/project/tp-timesheet/)\n\nAutomated submission of TP timesheets.\n\n* Version 0.x.x is web form only\n* Version 1.x.x is web + Clockify\n* Version 2.x.x is Clockify only\n\n## Installation\n### Install\nThis tool is published on pypi so from any terminal with python3 installed run:\n\n```bash\npip install tp-timesheet\n```\n**Note:** some outdated OS's still require pip3 instead of pip. If you get an error `Unknown command: pip` then try the following:\n```bash\npip3 install tp-timesheet\n```\n### Upgrade\n```bash\npip install --upgrade tp-timesheet\n```\n### Uninstall\n```bash\npip uninstall tp-timesheet\n```\n## Usage\n\nRun the tool with the help option to find out additional usage information\n\n```bash\ntp-timesheet --help\n```\n\n### Common cli options\n\n```bash\n# submit live hours (default) for today\ntp-timesheet --start today\n\n# submit live hours (default) for next 5 days\ntp-timesheet --start today --count 5\n\n# submit for Mon 3/10/22 to Thursday 6/10/22 with a task of Out Of Office (OOO)\ntp-timesheet --start '3/10/22' --count 5 -t OOO\n\n# Schedule the form to submit automatically on weekdays\ntp-timesheet --automate weekdays\n\n# append '--verbose' to any command to get more log messages about what is going on\n# append '--dry-run' to any command to avoid clicking submit. Good for testing\n```\n\n## Development\nInstall the dev environment and run tool locally:\n\n```bash\npip install -e .[dev]\n\ntp-timesheet --help\n```\n\nnote: if zsh is used, install the dev environment with:\n```bash\npip install -e \".[dev]\"\n```\n### Contributing \nTo run checks prior to committing\n\n```bash\nblack --check --diff tp_timesheet # See what formatting changes need to be made\nblack tp_timesheet # Run formatter\npylint tp_timesheet # Run linter\npytest # Run testing\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI tool to automate the submisison of tp timesheets",
    "version": "2.1.1",
    "project_urls": {
        "Homepage": "https://github.com/ThorpeJosh/tp-timesheet"
    },
    "split_keywords": [
        "automation",
        "timesheet",
        "cli",
        "executable"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7ee91249c03f0cb939deaec99ce5ecf8a91dadbe9135ad5ea186493abe038d9c",
                "md5": "ac82f60ff15316d51a91c56acb9576ff",
                "sha256": "b1f3862e272295310ef4b7d3c5ce538d0f1edf30c61b28014b5a1e358660d46b"
            },
            "downloads": -1,
            "filename": "tp_timesheet-2.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac82f60ff15316d51a91c56acb9576ff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12903,
            "upload_time": "2023-08-21T04:26:35",
            "upload_time_iso_8601": "2023-08-21T04:26:35.945745Z",
            "url": "https://files.pythonhosted.org/packages/7e/e9/1249c03f0cb939deaec99ce5ecf8a91dadbe9135ad5ea186493abe038d9c/tp_timesheet-2.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd868be3d257ad13fb5fbef99ce44ad3e7b2f677d9c60f6828bde85c36e343a5",
                "md5": "a73ea6de66ef36d0b32b1883af8eb315",
                "sha256": "aa59a9854c015607eaf474a84e63badb886b1b8c0e977e3a3b9cfc913f9e9c68"
            },
            "downloads": -1,
            "filename": "tp-timesheet-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a73ea6de66ef36d0b32b1883af8eb315",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12293,
            "upload_time": "2023-08-21T04:26:37",
            "upload_time_iso_8601": "2023-08-21T04:26:37.917160Z",
            "url": "https://files.pythonhosted.org/packages/bd/86/8be3d257ad13fb5fbef99ce44ad3e7b2f677d9c60f6828bde85c36e343a5/tp-timesheet-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-21 04:26:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ThorpeJosh",
    "github_project": "tp-timesheet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "tp-timesheet"
}
        
Elapsed time: 0.11644s