https://github.com/kiwiz/gkeepapi

An unofficial client for the Google Keep API.
https://github.com/kiwiz/gkeepapi

google-api google-keep python

Last synced: 28 days ago
JSON representation

An unofficial client for the Google Keep API.

• Host: GitHub
• URL: https://github.com/kiwiz/gkeepapi
• Owner: kiwiz
• License: mit
• Created: 2017-10-14T06:13:03.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T22:51:29.000Z (7 months ago)
• Last Synced: 2024-04-14T10:56:57.024Z (7 months ago)
• Topics: google-api, google-keep, python
• Language: Python
• Homepage:
• Size: 363 KB
• Stars: 1,475
• Watchers: 48
• Forks: 107
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
gkeepapi

========

[![Documentation Status](https://readthedocs.org/projects/gkeepapi/badge/?version=latest)](http://gkeepapi.readthedocs.io/en/latest/?badge=latest)

[![Gitter chat](https://badges.gitter.im/gkeepapi/Lobby.png)](https://gitter.im/gkeepapi/Lobby)

[![Test Coverage](https://api.codeclimate.com/v1/badges/4386792a941a156a14f0/test_coverage)](https://codeclimate.com/github/kiwiz/gkeepapi/test_coverage)

## NOTICE: Google offers an official [API](https://developers.google.com/keep/api) which might be an option if you have an Enterprise account. 🎉

An unofficial client for the [Google Keep](https://keep.google.com) API.

```python

import gkeepapi

# Obtain a master token for your account (see docs)

master_token = '...'

keep = gkeepapi.Keep()

success = keep.authenticate('[email protected]', master_token)

note = keep.createNote('Todo', 'Eat breakfast')

note.pinned = True

note.color = gkeepapi.node.ColorValue.Red

keep.sync()

```

*gkeepapi is not supported nor endorsed by Google.*

The code is pretty stable at this point, but you should always make backups. The project is under development, so feel free to open an issue if you have questions, see any bugs or have a feature request. PRs are welcome too!

## Installation

```

pip install gkeepapi

```

## Documentation

The docs are available on [Read the Docs](https://gkeepapi.readthedocs.io/en/latest/).

## Todo (Open an issue if you'd like to help!)

- Reminders

    - `reminders`

- Figure out all possible values for `TaskAssist._suggest` (Same as CategoryValue?)

- Figure out all possible values for `NodeImage._extraction_status` (integer)

- Blobs (Drawings/Images/Recordings)