Skip to main content

RTM API wrapper

Project description

codecov PyPI version

Python wrapper for "Remember the Milk" API

  • Asynchronous and synchronous APIs
  • Subscription support

Usage of client

from rtmilk.client import Client
from rtmmilk.models import RTMError

# These are the equivalent objects, created differently
client = Client.Create(API_KEY, SHARED_SECRET, TOKEN)
client2 = await Client.CreateAsync(API_KEY, SHARED_SECRET, TOKEN)

try:
    task = client.Add(name='name 1')
    assert task.complete.value is False
    task.tags.Set({'tag1', 'tag2'})
    assert task.tags.value == {'tag1', 'tag2'}
    task = await client.AddAsync(name='name 2')
    await task.tags.SetAsync({'tag1', 'tag2'})
    tasks = client2.Get('name:"name 1"')
    assert tasks[0].tags.value == {'tag1', 'tag2'}
except RTMError as e:
    print(e)

Usage of API functions directly

from rtmilk.api_sync import API
from rtmmilk.models import RTMError

api = API(API_KEY, SHARED_SECRET, TOKEN)

timeline = api.TimelinesCreate().timeline
try:
    api.TasksAdd(timeline, 'task name')
except RTMError as e:
    print(e)
from rtmilk.api_async import APIAsync
from rtmmilk.models import RTMError

apiAsync = APIAsync(API_KEY, SHARED_SECRET, TOKEN)

timeline = await apiAsync.TimelinesCreate().timeline
try:
    await apiAsync.TasksAdd(timeline, 'task name')
except RTMError as e:
    print(e)

Authorization

from rtmilk.authorization import AuthorizationSession

authenticationSession = AuthorizationSession(API_KEY, SHARED_SECRET, 'delete')
input(f'Go to {authenticationSession.url} and authorize. Then Press ENTER')
token = authenticationSession.Done()
print(f'Authorization token is {token}')

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

rtmilk-1.0.4.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

rtmilk-1.0.4-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file rtmilk-1.0.4.tar.gz.

File metadata

  • Download URL: rtmilk-1.0.4.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.1 Windows/10

File hashes

Hashes for rtmilk-1.0.4.tar.gz
Algorithm Hash digest
SHA256 5880b565882c06701501c6776d64e52eebe4fedc2f222f3189311d99098fd11a
MD5 79b152cf8685d41740499a33a48cb72f
BLAKE2b-256 c245300a9faf95f0c8e8b8e078113223ccddbbb2896cff4b7d09081135b623b3

See more details on using hashes here.

File details

Details for the file rtmilk-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: rtmilk-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.1 Windows/10

File hashes

Hashes for rtmilk-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e573b0fc3cdddb3aa2b135af57da4c7b20c831ba2f6bea366ccb0ff05dbeeada
MD5 974a6dfd5fc2188ef40cf36365a76658
BLAKE2b-256 c5bbb90377d64d2a7f109478e28f4de41b6fb1dad02c2cf5d8835d5be489a408

See more details on using hashes here.

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