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 import APIError, CreateClient, CreateClientAsync

# These are the equivalent objects, created differently
client = CreateClient(API_KEY, SHARED_SECRET, TOKEN)
client2 = await CreateClientAsync(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 APIError as e:
    print(e)

Usage of API functions directly

from rtmilk import API, 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 import APIAsync, 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 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-3.0.1.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

rtmilk-3.0.1-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rtmilk-3.0.1.tar.gz
Algorithm Hash digest
SHA256 65bb04b8bacef6bc98291a8dc252e09110abd9e26d73736c334e91cd3db149c3
MD5 62cae3f12aceda95725cd8a66313ce8f
BLAKE2b-256 369b2b5e08d795f8338c6c09d831aa1317475bb935c6019880a515456408ac96

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rtmilk-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 36eb1f0bf9a76d6d7c936976667d7b882f313a431143b177768b58e2a40f5701
MD5 2a99ddb4f3a8a4b9824009b26cf1adb1
BLAKE2b-256 841040a7fba5102a29492d510501a016cd443d9d88b8bcca907fbcf98e54c040

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