README.md.bak

# HWR

*Handwriting recognition for reMarkable notes.*

This is a small tool to extract text from handwritten notes created on the
[reMarkable](https://remarkable.com/) tablet.

it uses the reMarkable cloud API
and the [MyScript](https://myscript.com/) text recognition ReST API.

## Configuration and Setup
You need to enable "cloud sync" for your remarkable tablet
to make notes available for this tool.

When first run, *HWR* will ask for a "one time code"
which can be obtained at https://my.remarkable.com/:

```
$ hwr
Enter one time code from https://my.remarkable.com/:
_
```

You also need a [MyScript developer](https://developer.myscript.com/)
account, specifically an `application key` and `HMAC key` which needs to be
added to the configuration file at `~/.config/hwr-conf.yaml`:

```yaml
datadir: /home/USERNAME/.local/share/hwr
cachedir: /home/USERNAME/.cache/hwr
appkey: bbd1419d-aa40-4803-9607-5115c3085de9
hmackey: 33b89262-dde1-4f92-a183-034255db6895
```

The `datadir` and `cachedir` both contain sensitiv values, namely the
authentication token for the reMarkable API, all downloaded notes
and cached handwriting recognition results.

## Usage
Only one use is supported:

```
$ hwr NAME_OF_NOTE -l LANGUAGE
```

`NAME_OF_NOTE` is the display name of the notebook you want to convert into
text. It is case-insensitive and supports partial matches.
IF multiple notebooks match, all of them will be converted.

The `LANGUAGE` must be specified and it must be one of the
[languages supported by MyScript](https://developer.myscript.com/docs/interactive-ink/1.4/overview/text-languages/).
It defaults to `en`.

The result is written to a markdown file named after the notebook
in the current directory.

**Example:**

```
$ hwr handwr
… download notebook "Handwriting Recognition"
… recognize handwriting for "Handwriting Recognition"
✓ write "Handwriting Recognition" to "Handwriting Recognition.md"
✓ Done.
```