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-0.2.4.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

rtmilk-0.2.4-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtmilk-0.2.4.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Darwin/23.0.0

File hashes

Hashes for rtmilk-0.2.4.tar.gz
Algorithm Hash digest
SHA256 9067e5de3a177506119a3430e58e5bcbf8b2f2ba26def272b6c3fc6e3495cc33
MD5 290fa8fb6d537fda03623a75582ba89c
BLAKE2b-256 9436ab4c6aec67652335951baaaed4dd309b02aa546fd97445bb64ac8b9ad4a5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtmilk-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Darwin/23.0.0

File hashes

Hashes for rtmilk-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1f7bf4e671837352a296c78d77c1922090579c6d904f3eb5d079bd9eaa141063
MD5 a637da048a8019915def75dd5fb76514
BLAKE2b-256 e984dab432a16d9fb2343dac30a350c26cf60811e997504dd8dbb712ea6be0e4

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