Installation
Python 3.7 and above:
pip install "python-harvest_apiv2"
Usage
Personal Access Token
Create a Personal Access Token in the Developers page on Harvest as documented in the Harvest documentation https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/
import harvest
from harvest.harvestdataclasses import *
personal_access_token = PersonalAccessToken("ACCOUNT ID", "PERSONAL TOKEN")
client = harvest.Harvest("https://api.harvestapp.com/api/v2", personal_access_token)
client.get_currently_authenticated_user()
For Server Side Applications
Create an OAuth2 application in the Developers page on Harvest as documented in the Harvest documentation https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/
Authentication needs to occur before you make your Harvest client.
from requests_oauthlib import OAuth2Session
from oauthlib.oauth2 import WebApplicationClient
from dacite import from_dict
import harvest
from harvest.harvestdataclasses import *
webclient = WebApplicationClient(client_id="CLIENT ID")
oauth = OAuth2Session(client=webclient)
authorization_url, state = oauth.authorization_url("https://id.getharvest.com/oauth2/authorize")
print("Browse to here in your web browser and authenticate: ", authorization_url)
response_uri = input("Please copy the resulting URL from your browser and paste here:")
harv = OAuth2Session("CLIENT ID", state=state)
token = harv.fetch_token("https://id.getharvest.com/api/v2/oauth2/token", client_secret="CLIENT SECRET", authorization_response=response_uri, include_client_id=True, state=state)
oauth2_serverside_token = from_dict(data_class=OAuth2_ServerSide_Token, data=token)
oauth2_serverside = OAuth2_ServerSide(client_id="CLIENT ID", client_secret="CLIENT SECRET", token=oauth2_serverside_token, refresh_url="https://id.getharvest.com/api/v2/oauth2/token")
client = harvest.Harvest("https://api.harvestapp.com/api/v2", oauth2_serverside)
client.get_currently_authenticated_user()
For Client Side Applications
Create an OAuth2 application in the Developers page on Harvest as documented in the Harvest documentation https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/
Authentication needs to occur before you make your Harvest client.
from oauthlib.oauth2 import MobileApplicationClient
from dacite import from_dict
import harvest
from harvest.harvestdataclasses import *
mobileclient = MobileApplicationClient(client_id="CLIENT ID")
url = mobileclient.prepare_request_uri("https://id.getharvest.com/oauth2/authorize")
print("Browse to here in your web browser and authenticate: ", url)
response_uri = input("Please copy the resulting URL from your browser and paste here:")
response_uri = response_uri.replace('callback?', 'callback#')
token = mobileclient.parse_request_uri_response(response_uri)
oauth2_clientside_token = from_dict(data_class=OAuth2_ClientSide_Token, data=token)
client = harvest.Harvest("https://api.harvestapp.com/api/v2", oauth2_clientside_token)
client.get_currently_authenticated_user()
Run tests
From the root python-harvest_apiv2 directory
tox
Contributions
Contributions are welcome. Including tests helps decide on whether to merge the PR.
TODOs
- Write API doco for the Python client. The tests demonstrate how to use the library but that's not clear from this page.
- Support Detailed Reports page functionality in the module detailedreports
License
python-harvest_apiv2 is licensed under MIT style licence. See LICENSE for more details.