Harvest Forecast

tap-harvest-forecast from singer-io

Time Tracking Software

The tap-harvest-forecast extractor pulls data from Harvest Forecast that can then be sent to a destination using a loader.

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-harvest-forecast extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-harvest-forecast
  3. Configure the tap-harvest-forecast settings using
    meltano config
    :
  4. meltano config tap-harvest-forecast set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-harvest-forecast test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-harvest-forecast may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-harvest-forecast settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Refresh Token (refresh_token)

  • Environment variable: TAP_HARVEST_FORECAST_REFRESH_TOKEN

Your refresh token.

Client Secret (client_secret)

  • Environment variable: TAP_HARVEST_FORECAST_CLIENT_SECRET

Your client secret.

User Agent (user_agent)

  • Environment variable: TAP_HARVEST_FORECAST_USER_AGENT

The user agent to be sent with requests.

Client ID (client_id)

  • Environment variable: TAP_HARVEST_FORECAST_CLIENT_ID

Your client ID.

Start Date (start_date)

  • Environment variable: TAP_HARVEST_FORECAST_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Account ID (account_id)

  • Environment variable: TAP_HARVEST_FORECAST_ACCOUNT_ID

Your account ID.

End Date (end_date)

  • Environment variable: TAP_HARVEST_FORECAST_END_DATE

Date up to when historical data will be extracted.

As the Harvest Forecast API is not yet public, this tap is experimental and liable to break at any time. Please keep this in mind if you run into any issues (and submit a PR if you can fix something broken).

Retrieve Auth Credentials

Visit the developer tools page on Harvest's website and create a new oauth token.

Paste the Client ID you got from the above page in the url of a browser like https://id.getharvest.com/oauth2/authorize?client_id={OAUTH_CLIENT_ID}&response_type=code. Now you're able to login, click 'authorize app' and then are redirected to a url like this https://id.getharvest.com/oauth2/authorize?code={OAUTH_REFRESH_TOKEN}&scope=all. You will use this OAUTH_REFRESH_TOKEN in the following step to configure the oauth application.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-harvest-forecast extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-harvest-forecast

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api