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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file sdk-timeular-tools-0.1.tar.gz.

File metadata

  • Download URL: sdk-timeular-tools-0.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for sdk-timeular-tools-0.1.tar.gz
Algorithm Hash digest
SHA256 c7e1c440003fb53f9bd997c4577e8ae56b3027ccd6dbe3d09a118e4f3db53c15
MD5 9dca3fab8be72a8db1c506ccb6cb12e7
BLAKE2b-256 93f57940ff10234ba510abebd2f11b75c9fc374823b1104ab84effcedabf0945

See more details on using hashes here.

File details

Details for the file sdk_timeular_tools-0.1-py3-none-any.whl.

File metadata

  • Download URL: sdk_timeular_tools-0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for sdk_timeular_tools-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b408867dcc838ca9d1093e0f897490efc07ea3e9f04c994e1e80d5788f250eaa
MD5 818809cc088dd900ad37788d76a26f5a
BLAKE2b-256 ace7168e922570beafd2bb3337a3476d90ac1dcf65400e75545c66b632c9e2ea

See more details on using hashes here.

Supported by

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