Skip to main content

Python binding for Forecast Harverst API

Project description

PyForecast

https://img.shields.io/pypi/v/pyforecast.svg https://img.shields.io/travis/vafliik/pyforecast.svg Documentation Status

Work In Progress

This project is currently under development. During sleepless nights, with two screaming kids :)

Please be patient. I would be grateful for any feedback & suggestions.

Introduction

Python binding for Forecast App (Harvest) API

Forecast is the fast and simple way to schedule your team across projects.

As per Forecast FAQ there is not a public API for the app. This project uses the exposed backend API (looks like Forecast guys are OK with that)

  • Free software: Apache Software License 2.0

  • Documentation: https://pyforecast.readthedocs.io. (do not go there yet, it is also WIP. Basic usage is described in this README)

Features

Implemented

  • Client

  • Project

  • Person

  • Assignments

  • Milestones

  • Roles

  • User Connections

  • Placeholders

  • Who am I

TO DO

  • All PUT/POST requests (inserting/modifying data)

  • Documentation

Usage

Create an Authorization token in Forecast App: https://id.getharvest.com/developers

Create an instance of the forecast.Api using the Account ID and Authorization token:

>>> import forecast
>>> api = forecast.Api(account_id='account_id', authorization_token='authorization_token')

Example usage:

>>> for project in api.get_projects():
>>>    print(project.name, project.id)
Demo Project 101234
Killer App 106555

>>> person = api.get_person(42)
>>> print(person.first_name, person.last_name, person.email)
Pavel Pribyl pribyl.pavel@gmail.com

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.4 (2018-05-31)

  • Add caching for the remote API requests

0.1.3 (2018-05-30)

  • Support for exporting model data to JSON

0.1.2 (2018-05-30)

  • Stabilize the release numbering

  • Minor bugfixes, typos

0.1.1 (2018-05-29)

  • Complete the API wrappers

  • Give up on Python 2 support … for now?

0.1.0 (2018-05-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyforecast-0.1.4.tar.gz (12.8 kB view hashes)

Uploaded Source

Built Distribution

pyforecast-0.1.4-py2.py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page