| Name | timeoff JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | |
| Summary | Track vacation hours accrued. |
| upload_time | 2023-12-09 19:14:49 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
time off
vacation
pto
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# timeoff 🏝
[](https://pypi.python.org/pypi/timeoff) [](https://pypi.python.org/pypi/timeoff) [](https://pypi.python.org/pypi/timeoff) [](https://github.com/tifa/timeoff/actions/workflows/ci.yml)
Track your hours accrued and set goals and reminders to take a break!
```console
$ timeoff list
| o ,---.,---.
|--- .,-.-.,---.,---.|__. |__.
| || | ||---'| || |
`---'`` ' '`---'`---'` `
Current schedule: SemiMonthly
4 hours on the 1st and 15th of the month
╭────────────┬───────┬──────────┬─────────┬─────────────╮
│ Start │ End │ Type │ Hours │ Remaining │
├────────────┼───────┼──────────┼─────────┼─────────────┤
│ │ │ Initial │ 100 │ 100 │
│ 2023-05-12 │ - │ Vacation │ -8 │ 92 │
│ 2023-05-15 │ - │ Accrued │ 4 │ 96 │
╰────────────┴───────┴──────────┴─────────┴─────────────╯
```
## Features
- Automaticaly updates PTO hours over time.
- Define schedules to set accrued PTO rates.
- View the remaining hours of PTO available to you.
## Installation
To install ``timeoff``:
```console
$ pip install timeoff
```
## Usage
Documentation is in the works! Please run the `-h` help flag in the meantime. The interactive prompts will guide you through further instructions.
```console
$ timeoff -h
usage: timeoff [-h] {add,list,rm,settings} ...
Timeoff CLI
positional arguments:
{add,list,rm,settings}
sub-command help
add Add an absence
list List absences
rm Remove an absence
settings Manage settings
optional arguments:
-h, --help show this help message and exit
```
The data is stored in `~/.timeoff`.
### Python API
You can also use this as a Python library.
Retrieve a list of all PTO hours remaining and absenses taken.
```python
import timeoff
timeoff.get()
```
Return the number of hours of PTO remaining as of today.
```python
timeoff.available_hours()
```
You can also pass in a future date to see how many hours you'll have accumulated by then.
```python
from datetime import date
timeoff.available_hours(date(2023, 9, 4))
```
Raw data
{
"_id": null,
"home_page": "",
"name": "timeoff",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "time off,vacation,pto",
"author": "",
"author_email": "Tiffany Huang <hello@tifa.io>",
"download_url": "https://files.pythonhosted.org/packages/05/60/4677fc215bbeebd7b8cbc37cb0970339bbf072181d04bd82dc1ead338fc4/timeoff-0.0.6.tar.gz",
"platform": null,
"description": "# timeoff \ud83c\udfdd\n\n[](https://pypi.python.org/pypi/timeoff) [](https://pypi.python.org/pypi/timeoff) [](https://pypi.python.org/pypi/timeoff) [](https://github.com/tifa/timeoff/actions/workflows/ci.yml)\n\nTrack your hours accrued and set goals and reminders to take a break!\n\n```console\n$ timeoff list\n\n | o ,---.,---.\n |--- .,-.-.,---.,---.|__. |__.\n | || | ||---'| || |\n `---'`` ' '`---'`---'` `\n\n Current schedule: SemiMonthly\n 4 hours on the 1st and 15th of the month\n\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 Start \u2502 End \u2502 Type \u2502 Hours \u2502 Remaining \u2502\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 \u2502 \u2502 Initial \u2502 100 \u2502 100 \u2502\n\u2502 2023-05-12 \u2502 - \u2502 Vacation \u2502 -8 \u2502 92 \u2502\n\u2502 2023-05-15 \u2502 - \u2502 Accrued \u2502 4 \u2502 96 \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n## Features\n\n- Automaticaly updates PTO hours over time.\n- Define schedules to set accrued PTO rates.\n- View the remaining hours of PTO available to you.\n\n## Installation\n\nTo install ``timeoff``:\n\n```console\n$ pip install timeoff\n```\n\n## Usage\n\nDocumentation is in the works! Please run the `-h` help flag in the meantime. The interactive prompts will guide you through further instructions.\n\n```console\n$ timeoff -h\nusage: timeoff [-h] {add,list,rm,settings} ...\n\nTimeoff CLI\n\npositional arguments:\n {add,list,rm,settings}\n sub-command help\n add Add an absence\n list List absences\n rm Remove an absence\n settings Manage settings\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\nThe data is stored in `~/.timeoff`.\n\n### Python API\n\nYou can also use this as a Python library.\n\nRetrieve a list of all PTO hours remaining and absenses taken.\n\n```python\nimport timeoff\ntimeoff.get()\n```\n\nReturn the number of hours of PTO remaining as of today.\n\n```python\ntimeoff.available_hours()\n```\n\nYou can also pass in a future date to see how many hours you'll have accumulated by then.\n\n```python\nfrom datetime import date\ntimeoff.available_hours(date(2023, 9, 4))\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Track vacation hours accrued.",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/tifa/timeoff"
},
"split_keywords": [
"time off",
"vacation",
"pto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "362b4c9af2708982f4ba185ac25c89b4445f23fafb2fd52107a473166871bd98",
"md5": "ae46b09759b073fba5af56b474d13aa7",
"sha256": "d26be36fa35b19eea80aae59a7d3253a6be41cd3c4fc0f47e5cc225a9a40602d"
},
"downloads": -1,
"filename": "timeoff-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae46b09759b073fba5af56b474d13aa7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12222,
"upload_time": "2023-12-09T19:14:47",
"upload_time_iso_8601": "2023-12-09T19:14:47.826479Z",
"url": "https://files.pythonhosted.org/packages/36/2b/4c9af2708982f4ba185ac25c89b4445f23fafb2fd52107a473166871bd98/timeoff-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05604677fc215bbeebd7b8cbc37cb0970339bbf072181d04bd82dc1ead338fc4",
"md5": "409ff4f401b22fa63e52b2b9f76a9f36",
"sha256": "a91e290604a50996761524e8175dc6af8d435889fa5e969b898225a9b62dd6ec"
},
"downloads": -1,
"filename": "timeoff-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "409ff4f401b22fa63e52b2b9f76a9f36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 25913,
"upload_time": "2023-12-09T19:14:49",
"upload_time_iso_8601": "2023-12-09T19:14:49.432322Z",
"url": "https://files.pythonhosted.org/packages/05/60/4677fc215bbeebd7b8cbc37cb0970339bbf072181d04bd82dc1ead338fc4/timeoff-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 19:14:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tifa",
"github_project": "timeoff",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "timeoff"
}
