diff options
| -rw-r--r-- | README.md | 48 | ||||
| -rw-r--r-- | README.rst | 52 |
2 files changed, 52 insertions, 48 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index fd03c0c..0000000 --- a/README.md +++ /dev/null @@ -1,48 +0,0 @@ -Harvester Submit Week For Approval -================================== - -This program will automatically submit this week's time sheet for approval. It -is intended to be run automatically by `launchd` or `cron`. The time sheet will -only be submitted if at least one time entry has been added for every weekday in -the week. - -By automating the time sheet submission, the program frees human time loggers -from having to remember or worry about doing so. - -This script is implemented with Selenium using Firefox's headless mode (or -another browser, if you prefer). At the time of implementation, no API exists to -submit time sheets for approval, and authenticity tokens made it difficult to -use regular HTTP requests, leaving Selenium the only remaining option. - - -## Install -1. Clone the repository -2. Install dependencies - - $ pipenv install - -3. (OS X only) Modify the - `com.teddywing.harvester-submit-week-for-approval.plist` file: - - a. Change the executable path to the virtualenv's `python3` - b. Use the absolute path to `harvester_submit_week_for_approval.py` - c. Fill in Harvest account details. A developer token can be obtained at - https://id.getharvest.com/developers - d. Put the plist in `~/Library/LaunchAgents/` - e. Load the plist with - - launchctl load /path/to/com.teddywing.harvester-submit-week-for-approval.plist - -4. Download [geckodriver][1] - - a. Replace the `geckodriver` path on [this line][2] with the absolute path - to the executable on your machine. - - -## License -Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included -COPYING file). - - -[1]: https://github.com/mozilla/geckodriver/releases -[2]: https://github.com/teddywing/harvester-submit-week-for-approval/blob/faa4d4c0831b70b5e103d0337c816db025ef8a9f/harvester_submit_week_for_approval.py#L209 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1bf4d2b --- /dev/null +++ b/README.rst @@ -0,0 +1,52 @@ +Harvester Submit Week For Approval +================================== + +This program will automatically submit this week’s time sheet for approval. It +is intended to be run automatically by ``launchd`` or ``cron``. The time sheet +will only be submitted if at least one time entry has been added for every +weekday in the week. + +By automating time sheet submission, the program frees human time loggers from +having to remember or worry about doing so. + +This script is implemented with Selenium using Firefox’s headless mode (or +another browser, if you prefer). At the time of implementation, no API exists to +submit time sheets for approval, and authenticity tokens made it difficult to +use regular HTTP requests, leaving Selenium the only remaining option. + + +Install +------- + +1. Clone the repository +2. Install dependencies:: + + $ pipenv install + +3. (OS X only) Modify the + ``com.teddywing.harvester-submit-week-for-approval.plist`` file: + + a. Change the executable path to the virtualenv’s ``python3`` + b. Use the absolute path to ``harvester_submit_week_for_approval.py`` + c. Fill in your Harvest account details. A developer token can be obtained + at https://id.getharvest.com/developers. + d. Put the plist in ``~/Library/LaunchAgents/`` + e. Load the plist with:: + + launchctl load /path/to/com.teddywing.harvester-submit-week-for-approval.plist + +4. Download `geckodriver`_ + + a. Replace the ``geckodriver`` path on `this line`_ with the absolute path + to the executable on your machine. + + +License +------- + +Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included +COPYING file). + + +.. _geckodriver: https://github.com/mozilla/geckodriver/releases +.. _this line: https://github.com/teddywing/harvester-submit-week-for-approval/blob/faa4d4c0831b70b5e103d0337c816db025ef8a9f/harvester_submit_week_for_approval.py#L209 |