Metadata-Version: 2.1
Name: google-reminder-api-wrapper
Version: 0.0.1
Summary: An unofficial API wrapper for the Google Reminder
Home-page: https://github.com/windmark/google-reminder-api-wrapper
Author: Marcus Windmark
Author-email: marcus.windmark@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.21.0)
Requires-Dist: python-dateutil (==2.7.5)

# API wrapper for Google Reminder

This is a work in progress to create an API wrapper for handling Google Reminders via code. Due to missing official
documentation of the API, this should be considered unstable and not deployed to any production systems.

The current commands are implemented
* get
* list
* create
* delete

Not implemented commands
* update


## Installing
Install the package with requirements by running
```bash
python3 setup.py install
```
Note that this package requires Python 3.


## Usage
Following the instructions below on how to acquire the API session credentials and add them to your environment variables.
```bash
SID='xxxxxxxxxxxxxxxxx' HSID='xxxxxxxxxxxxxxxxx' SSID='xxxxxxxxxxxxxxxxx' APISID='xxxxxxxxxxxxxxxxx' SAPISID='xxxxxxxxxxxxxxxxx' authorization='xxxxxxxxxxxxxxxxx' key='xxxxxxxxxxxxxxxxx' python
```

```python
from google_reminder_api_wrapper import ReminderApi

api = ReminderApi()
reminders = api.list()
print(reminders)

new_reminder = api.create('Test reminder', '2019-01-10 15:00')
reminders = api.list()
print(reminders)

api.delete(new_reminder)
reminders = api.list()
print(reminders)
```


## Underlying Google Reminder API
### Authorization
Currently, the Google session is still based on fixed cookies and authorization keys in the HTTP header.

```bash
SID = "xxxxxxxxxxxxxxxxx"
HSID = "xxxxxxxxxxxxxxxxx"
SSID = "xxxxxxxxxxxxxxxxx"
APISID = "xxxxxxxxxxxxxxxxx"
SAPISID = "xxxxxxxxxxxxxxxxx"
authorization = "xxxxxxxxxxxxxxxxx"
key = "xxxxxxxxxxxxxxxxx"
```

Note: The credential keys need to be set as environment variables for the requests to work. This is
a work in progress and will in the future be integrated with the Google sessions API.


#### Finding Credentials
Credentials can be found by doing the following
1. Go to Google Calendar, https://calendar.google.com and make sure the "Reminder" calendar is marked.
2. Open the "Network" tab of the Chrome Developer Tool and search for `reminders / list`
3. In the "Header" sub-tab, find the required headers in the "Request Header"


### Request Structure
The following is the main structure of the request sent to the Reminders API
`https://reminders-pa.clients6.google.com/v1internalOP/reminders/<COMMAND>`.

where COMMAND is one of the following
* get
* list
* update
* create
* delete

Header
```bash
'x-origin': 'https://calendar.google.com',
'content-type': 'application/json',
'authorization': '<SESSION AUTHORIZATION>,'
'key': '<SESSION KEY>,'
'cookie': '<SESSION COOKIES>'
```

The Google Calendar is using this API with `application/json+protobuf` in the data payload, but due to readability problems
this wrapper has reverse-engineered parts of the schema to normal JSON field names.


## Backstory
Due to popular demand as seen in the following Google Issue Tracker thread, https://issuetracker.google.com/issues/36760283,
I decided to give it a try. The wrapper is based on the following comment, https://issuetracker.google.com/issues/36760283#comment193.

The  is based on the following comment, https://issuetracker.google.com/issues/36760283#comment193,
```
There is an undocumented API, which is used for example by Google Calendar. Maybe someone with the skills and time can write a user friendly wrapper or service for it ;-)
https://reminders-pa.clients6.google.com/v1internalOP/reminders/list?key=XXX

Commands are: list, get, create, update, delete

Some more details for "list" in Japanese: https://qiita.com/futa/items/c7a04c7b0be35508a626
```

