https://github.com/theogf/remarkable.jl

Julia API to the Remarkable cloud
https://github.com/theogf/remarkable.jl

remarkable remarkable-tablet

Last synced: 15 days ago
JSON representation

Julia API to the Remarkable cloud

• Host: GitHub
• URL: https://github.com/theogf/remarkable.jl
• Owner: theogf
• License: mit
• Created: 2020-11-03T23:43:27.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-02T15:08:52.000Z (9 months ago)
• Last Synced: 2024-10-12T15:19:38.561Z (24 days ago)
• Topics: remarkable, remarkable-tablet
• Language: Julia
• Homepage:
• Size: 8.44 MB
• Stars: 38
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Remarkable.jl

API for the ReMarkable cloud. Based on [`RemarkableAPI`](https://github.com/splitbrain/ReMarkableAPI), you can find a detailed API documentation in its [wiki](https://github.com/splitbrain/ReMarkableAPI/wiki).

## Setup

To use the API you first need to register your device:

Get a authentification code on https://my.remarkable.com/device/desktop/connect and call `Remarkable.register("your code here")`. This will create a token and save it as `.token` in your current folder (you can change this by calling `Remarkable.register("code", path_to_token = "/home/my/path")`.

Once this is done create a client with `RemarkableClient()` which will by default look for a `.token` file in your current folder or can take directly a token string(check the docs with `?`!)

## Doing cool stuff!

From there you can :

- Access your data! `data = list_items(client)` will return a `Collection` containing all documents and sub folders. You can visualize nicely the structure by calling `print_tree(data)`.

- Get a specific item! You can directly parse the `data` and select the item of you interest. If you know your item `ID` you can also do it via `get_item(client, ID)`.

- Download an item! Just call `download(client, item, local_path)`.

This will download the item as a `.zip` file. If you just want the `.pdf`, `download_pdf` is also possible.

- Upload a pdf! Call `upload_pdf!(client, path_to_pdf, pdf_name, parent)` where parent is the folder ID or a `Collection`.

- Delete an item! Call `delete_item!(client, item)` and you can say goodbye!

Everything is done with `HTTP.request`, you can pass any `request` keyword argument to all functions (for example setting `verbose=2`) (only avoid `query`)

## A small demo

Here is a small script getting a list of file, downloading one, renaming it and reuploading it :

```julia

client = RemarkableClient()

items = list_items(client)

print_tree(items) |> display

#= 

Root

├─ Quick sheets

├─ SVGD Integration

├─ Books

│  └─ entropy-22-01100

├─ Teaching

│  └─ PML 20/21

├─ Derivations

=#

item = items[3][1] # entropy-22...

file_path = download_pdf(client, item, pwd())

mv(file_path, "new_name.pdf")

upload_pdf!(client, "new_name.pdf", "Entropy Book.pdf", items[3]) # We reupload in the same location

delete_item!(client, item) # we delete the old item

```