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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtmilk-0.0.3.tar.gz
  • Upload date:
  • Size: 8.3 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.3.tar.gz
Algorithm Hash digest
SHA256 47e18042fdb81e0f4939c73c7a4787b223f7fcec22a3a43c1b7155206092a060
MD5 4045cc6ea3d94b6b3b9d5f78295da577
BLAKE2b-256 8235831176638b81f1db305d622f0f2992e0d4d924d796878be0bf7db69b23f5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtmilk-0.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cff1183a5dd58097c2794aaa6555056ca7ed02e5ad3c80add92e59a583def320
MD5 e9be8a69b3bb4fd7b1e65ae1ba491811
BLAKE2b-256 48ac47bfe3f67f5f2998f6a2ca77c0d3fee93252385129d57313cae78ae6d3ad

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