Skip to main content

A python wrapper around the Timeular HTTP API, and some notebooks of questionable usefulness

Project description

sdk-timeular-tools

a completely unofficial timeular python SDK and some simple utilities and notebooks

The Timeular v3 API docs can be found (here)[https://developers.timeular.com/].

Usage

See the (notebooks)[./notebooks] directory for usage examples.

from timeular import timeular

with timeular.TimeularSession(API_KEY, API_SECRET) as ts:
    activities = ts.activities()
    # and so on...

Methods available:

activities

  def list_activities()
  def update_activity(id, **new_values)
  def archive_activity(id)

devices

  def list_devices()
  def set_active_device(device_id)
  def release_active_device()
  def edit_device_name(device_id, name)
  def forget_device(device_id)
  def disable_device(device_id)
  def enable_device(device_id)

tracking

  def get_current_tracking()
  def start_tracking(id) # no idea what the ID is here.
  def edit_current_tracking(note, activity_id, started_at)
  def stop_tracking()

entries

  def find_entries_in_range(start_dt, stop_dt)
  def create_entry(activity_id, start_dt, stop_dt, note_text)
  def get_entry(entry_id)
  def edit_entry(entry_id, activity_id=None, start_dt=None, stop_dt=None, note_text=None)
  def delete_entry(entry_id)

reports

  def generate_report_csv(start_dt, end_dt, timezone=tzlocal.get_localzone().zone)
  def report_report_json(start_dt, end_dt)

tags and mentions

  def get_tags_and_mentions()
  def create_tag(key, label, scope, space_id)
  def update_tag(tag_id, key=None, label=None, scope=None, space_id=None)
  def delete_tag(tag_id)
  def create_mention(key, label, scope, space_id)
  def update_mention(mention_id, key=None, label=None, scope=None, space_id=None)
  def delete_mention(mention_id)

user and group info

  def me()
  def list_spaces()

webhooks

  def list_webhook_events()
  def subscribe(event, target_url)
  def unsubscribe(subscription_id)
  def list_subscriptions()
  def unsubscribe_all()

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

sdk-timeular-tools-0.1.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

sdk_timeular_tools-0.1-py3-none-any.whl (5.6 kB view hashes)

Uploaded 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