Skip to content

Update README.md for first time users #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nthapaliya wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md for first time users #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d7a02d
Update README.md for first time users
nthapaliya Nov 12, 2020
bba002a
Add basic cron instructions
nthapaliya Jan 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# api_client_python
Some examples to show how to interact with the OfficeSpace API using Python

# Prerequisites

## External libraries
This script depends on the python library `requests` to work. Make sure
it is installed before running.

A quick way install `requests` if it isn't yet:
```bash
sudo easy_install pip
sudo pip install --upgrade pip
pip install requests
```

## Optional: Scheduling via `crontab`

If you wish to schedule the script to run at specific intervals,
you have to set up a cron job.

1) Decide the frequency at which you want to run the script and note the cron
expression for it. For example, if you want to run it every hour,
the cron expression would look like "0 * * * *".
Use https://crontab.guru/ as reference.
2) Run `crontab -e` to edit the cron file.
3) Put in a new line: `<crontab expression> <full path to python> <full path to script>`
For example, a new line could be `30 * * * * /usr/bin/python /Users/johndoe/projects/bamboo_to_officespace.py`
Save the file and exit the editor.
4) `crontab -l` to check if the new settings apply. You should see the latest task in the list.