Skip to main content

Remember The Milk 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 FailStat

api = API(API_KEY, SHARED_SECRET, TOKEN)

timeline = api.TimelinesCreate().timeline
result = api.TasksAdd(timeline, 'task name')
if isinstance(result, FailStat):
    print(f'Error: {result}')
from rtmilk.api_async import APIAsync
from rtmmilk.models import FailStat

apiAsync = APIAsync(API_KEY, SHARED_SECRET, TOKEN)

timeline = await apiAsync.TimelinesCreate().timeline
result = await apiAsync.TasksAdd(timeline, 'task name')
if isinstance(result, FailStat):
    print(f'Error: {result}')

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

Uploaded Source

Built Distribution

rtmilk-2.1.1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtmilk-2.1.1.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.18

File hashes

Hashes for rtmilk-2.1.1.tar.gz
Algorithm Hash digest
SHA256 5785b3957491cd3510894a8ffbee2ebfcf40173c4c9fccf91d4b999c60311d2e
MD5 c72cfe8ddb422df8f6b94e7e04a6adc1
BLAKE2b-256 ac60cffbf16018ab083c7273a2333247770531986c0532a8ee3465b2086f7570

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtmilk-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.18

File hashes

Hashes for rtmilk-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b296ac446f72ed6358d15aae15e692b399eb422eb6617e45487f3372b7749fe
MD5 2699321304705d892f78781a0671e043
BLAKE2b-256 60e87c57b910c9b1afad13b277e65ac96859c611fb9b86a553ba3289db9b849b

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