| Name | popleave JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | Populates Leave Forms from the Command Line |
| upload_time | 2024-07-11 15:34:07 |
| maintainer | None |
| docs_url | None |
| author | Alex Drysdale |
| requires_python | <4.0,>=3.12 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Leave Populator
Asks the minimum amount of questions to populate a leave request form.
## Installation
# Recommended
```sh
pip install popleave
```
## Local installation
1. Install [poetry](https://python-poetry.org/docs/#installation) following the official guidelines for your system.
2. Clone the repository.
3. Install the dependencies.
```sh
poetry install
```
## Usage
### First run
Run the program with
```sh
popleave
```
On the first run, you will be asked for your name:
```
Enter name (press Enter to use Samwise Gamgee):
```
and your department:
```
Enter department (press Enter to use The Shire):
```
and the current amount of days holiday you have remaining:
```
Enter remaing_days_leave (press Enter to use 26):
```
If you ever need to change or correct these details, pass the `--init` flag when running the script:
```sh
popleave --init
```
and you will be able to update the values accordinly.
### Populating a form
When run you will then be prompted for:
- The start date of your leave.
- The duration of your leave.
- The reason for your leave.
If you'd rather, you can use commandline arguments.
A full list of commandline arguments can be found by using the `--help` flag.
```sh
usage: popleave [-h] [-i] [-s START_DATE] [-e END_DATE] [-d DURATION]
[-r REASON] [-t]
Populates the leave of absence form with a CLI
options:
-h, --help show this help message and exit
-i, --init Forces reinitialisation of config file.
-s START_DATE, --start_date START_DATE
Start date in YYYY-MM-DD format.
-e END_DATE, --end_date END_DATE
End date in YYYY-MM-DD format.
-d DURATION, --duration DURATION
Duration in days.
-r REASON, --reason REASON
Reason for leave.
-t, --toil Fills out Time Off In Leu instead of annual leave.
```
All resulting forms will be stored in the current directory in the format `INITIALS_ANNUAL_STARTDATE.docx`.
Thus Samwise Gamgee requesting some leave starting on 1969-12-31 will result in:
```
SG_ANNUAL_31121969.docx
```
## License
This project is licensed under the [GPLv3 license](LICENSE).
## Contributing
All contributions welcome. Submit a pull a request or create an issue to start the ball rolling.
Raw data
{
"_id": null,
"home_page": null,
"name": "popleave",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Alex Drysdale",
"author_email": "alexander.drysdale@wales.nhs.uk",
"download_url": "https://files.pythonhosted.org/packages/eb/36/22a5827edb61f61cf10ec8303dfb97479b37e780cda59be4492d8b53b119/popleave-0.1.4.tar.gz",
"platform": null,
"description": "# Leave Populator\n\nAsks the minimum amount of questions to populate a leave request form.\n\n## Installation\n\n# Recommended\n\n```sh\npip install popleave\n```\n\n## Local installation\n\n1. Install [poetry](https://python-poetry.org/docs/#installation) following the official guidelines for your system.\n\n2. Clone the repository.\n\n3. Install the dependencies.\n\n```sh\npoetry install\n```\n\n## Usage\n\n### First run\n\nRun the program with\n\n```sh\npopleave\n```\n\nOn the first run, you will be asked for your name:\n\n```\nEnter name (press Enter to use Samwise Gamgee): \n```\n\nand your department:\n\n```\nEnter department (press Enter to use The Shire):\n```\n\nand the current amount of days holiday you have remaining:\n\n```\nEnter remaing_days_leave (press Enter to use 26):\n```\n\nIf you ever need to change or correct these details, pass the `--init` flag when running the script:\n\n```sh\npopleave --init\n```\nand you will be able to update the values accordinly.\n\n### Populating a form\n\nWhen run you will then be prompted for:\n\n- The start date of your leave.\n- The duration of your leave.\n- The reason for your leave.\n\nIf you'd rather, you can use commandline arguments.\nA full list of commandline arguments can be found by using the `--help` flag.\n\n```sh\nusage: popleave [-h] [-i] [-s START_DATE] [-e END_DATE] [-d DURATION]\n [-r REASON] [-t]\n\nPopulates the leave of absence form with a CLI\n\noptions:\n -h, --help show this help message and exit\n -i, --init Forces reinitialisation of config file.\n -s START_DATE, --start_date START_DATE\n Start date in YYYY-MM-DD format.\n -e END_DATE, --end_date END_DATE\n End date in YYYY-MM-DD format.\n -d DURATION, --duration DURATION\n Duration in days.\n -r REASON, --reason REASON\n Reason for leave.\n -t, --toil Fills out Time Off In Leu instead of annual leave.\n```\n\nAll resulting forms will be stored in the current directory in the format `INITIALS_ANNUAL_STARTDATE.docx`.\nThus Samwise Gamgee requesting some leave starting on 1969-12-31 will result in:\n```\nSG_ANNUAL_31121969.docx\n```\n\n## License\n\nThis project is licensed under the [GPLv3 license](LICENSE).\n\n## Contributing\n\nAll contributions welcome. Submit a pull a request or create an issue to start the ball rolling.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Populates Leave Forms from the Command Line",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80382f7c01393aac081ebf69f74a44a3b48a9658726bc6de68b3cd08602ff4be",
"md5": "3dc1e7eacc963305e2fd5bdd61972ff9",
"sha256": "7a75c6a28275ba676b6156aa385254f9245e7da2485d2a4ee998af8403fb13dd"
},
"downloads": -1,
"filename": "popleave-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3dc1e7eacc963305e2fd5bdd61972ff9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 34681,
"upload_time": "2024-07-11T15:34:06",
"upload_time_iso_8601": "2024-07-11T15:34:06.021469Z",
"url": "https://files.pythonhosted.org/packages/80/38/2f7c01393aac081ebf69f74a44a3b48a9658726bc6de68b3cd08602ff4be/popleave-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb3622a5827edb61f61cf10ec8303dfb97479b37e780cda59be4492d8b53b119",
"md5": "2d6ed3131778003b7420292ed3ebaf9f",
"sha256": "81dd7ddca54c8b497380002970ea3be0d3c49e8da3db50bfc9594c4d4a262223"
},
"downloads": -1,
"filename": "popleave-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "2d6ed3131778003b7420292ed3ebaf9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 35708,
"upload_time": "2024-07-11T15:34:07",
"upload_time_iso_8601": "2024-07-11T15:34:07.048561Z",
"url": "https://files.pythonhosted.org/packages/eb/36/22a5827edb61f61cf10ec8303dfb97479b37e780cda59be4492d8b53b119/popleave-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 15:34:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "popleave"
}
