Package: remarking
RemarkingReport a Bug·Request a Feature.Ask a QuestionAboutRemarking is a command line tool for extracting highlights from documents on your reMarkable tablet.Remarking makes it as easy as possible to extract highlights from your annotated documents.Remarking serves to be the first part of a highlight extraction pipeline.This means, you can use Remarking to extract your highlights for then futher processing such as:Sending it to a serviceCombining it with another collection of highlightsFurther filtering of highlights with more toolingI found that there was no easy way of extracting highlights from the reMarkable. There were quite a few
tools that focussed solely on extracting the highlights from the downloaded pdfs. However, nothing made
the process as easy as specifiying the folder to scan for documents.InstallationRequirementsYou will need at least:Python 3.7+PipInstallTo get started you can install the package from pip with:pip3 install remarkingTheremarkingcommand should then be available for you to use.UsageCheck out thedocsfor help, or runremarking --help.TokenBefore you start you will need to grab a one-time authorization key fromhttps://my.remarkable.com/device/connect/desktop. This code is used to access the reMarkable cloud.rmapyis used to access the reMarkable Cloud. After authorizing the first time, the tool will store an auth
token in~/.rmapifor future use. You won't need to re-authorize by providing the token again until you deauthorize
the key.You can specify the token through theREMARKING_TOKENenv var in addition to via command line with--token.ModesThere are two main modes of usage of Remarking: run and persist.runremarking runwill run the default extractors on all passed documents and folders. Highlights extracted
are then output using the writer subcommand passed.remarking run json booksThis command will run the default extractors on all documents in the books folder and output the highlights as json.persistremarking persistperforms the same extraction on documents as run, however it maintains state
of previously seen documents and highlights.By default it creates aremarking_database.sqlite3database file in the current working directory that keeps track of
seen highlights and documents.You can also use your own database by providing the--sqlalchemyargument with a sqlalchemy connection string.remarking persist json booksThis command will run the default extractors on all documents in the books folder and output the highlights as json.All documents and their highlights found would also be added to the sqlite3 databaseremarking_database.sqlite3.A second run would return no new highlights if the documents in the books folder are not modified.ExamplesYou can check out some examples inthe examples section of the docs.RoadmapSee theopen issuesfor a list of proposed features (and known issues).Built WithPython 3rmapyclicksqlalchemySupportReach out to the maintainer at one of the following places:GitHub issuesThe email which is locatedin this GitHub profileContributingFirst off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and aregreatly appreciated.We have set up a separate document containing ourcontribution guidelines.Thank you for being involved!Authors & contributorsThe original setup of this repository is bySamy Abidib.For a full list of all authors and contributors, checkthe contributor's page.SecurityRemarking follows good practices of security, but 100% security can't be granted in software.
Remarking is provided"as is"without anywarranty. Use at your own risk.For more info, please refer tosecurity.LicenseThis project is licensed under theGPL v3license.SeeLICENSEfor more information.AcknowledgementsrmapyremarksbiffsqlalchemyThe unofficial reMarkable discord