Skip to main content

RTM API wrapper

Project description

rtmilk

Python wrapper for "Remember the Milk" API

Idea

Idea is to use pydantic to (de)structure the requests and responses There is a raw api wrapper called API which handles authorization, wrapping each call in a function and removing common fields There will be a higher level wrapper which will have objects representing the implicit objects in the API e.g. Task, TaskSeries, List

Authorization layer

Stores the key, secret etc Generates the api sig Makes generic authorized/unauthorized calls. Inputs are able to be coerced to strings. Outputs are dictionaries that come out of the json parsing

Wrappers for the specific RTM calls

Inputs are proper types like datetime, enums, lists Outputs are parsed out into the same types (datetime, enums, lists etc) Should it throw RTM errors rather than return parsed fail objects? Probably, since it's possible with complete fidelity and fits with the way the code has to be written

Task objects

Ordering of start/due dates Hide whether they're dates or datetimes Hiding of "no tag"/tag type inconsistency Coalesce sending of different attributes to the server with an explicit call - have to do that for start/due dates anyway Validate the repeat input values

List objects

Sometimes you only get the listid back, could hide the expansion of the other attributes

Filter objects

Construct from string Construct from logical combination of conditions Output strings to the server using the pydantic stuff

Client layer

First entry point Search for tasks CRUD for lists Holds the API object

Future?

Make it sansio, so that we can use other than requests

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

Uploaded Source

Built Distribution

rtmilk-0.0.4-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtmilk-0.0.4.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.1 Darwin/20.5.0

File hashes

Hashes for rtmilk-0.0.4.tar.gz
Algorithm Hash digest
SHA256 eaec0d5eba444a18554fed94cc4dff59df7b55fde06b1a2ee76c96b526d6048c
MD5 f14d6ab55b4f985a2db85c756846035d
BLAKE2b-256 28cade532acf7966931389adb31b520bc0936c7b00bc7be19b23818d45f4f125

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtmilk-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.1 Darwin/20.5.0

File hashes

Hashes for rtmilk-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ea132e678f4c1867f974de034247ccfeae549f61f8c4112fa8df6e51ec8f4923
MD5 2222fa19f3297697cbaca28b58ff076d
BLAKE2b-256 9c40963fe80289a509087ef255b8d1ba6ea8c08ced75097919ac5b3139a945a3

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