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

Uploaded Source

Built Distribution

rtmilk-0.0.2-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtmilk-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 40127f373373815678fd55a12589b8ea962510d5e1b53b5a226e15b19d7a9830
MD5 e52e9b4711b450adc333931b6abc482d
BLAKE2b-256 298f03908601b5ac720c78e57651c56a4776ea5dd917307f9b910342e3b9cabf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtmilk-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a900b289eba5c94552642b41c3c845ff9ad8c93eadd1a73cb3ce28fd4140b7a4
MD5 282acc98e39354f8cf983b064241e86a
BLAKE2b-256 e097d1eb351d754aec22f9d35c6cc2c0b93c1edbbcf4239250411bd6bf661a77

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