{"id":13771167,"url":"https://github.com/jwoglom/remarkable-substack","last_synced_at":"2025-12-25T05:29:12.379Z","repository":{"id":185101123,"uuid":"626229147","full_name":"jwoglom/remarkable-substack","owner":"jwoglom","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-05T21:14:52.000Z","size":54,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-18T19:36:45.284Z","etag":null,"topics":["remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwoglom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-11T03:47:22.000Z","updated_at":"2024-08-03T01:54:45.862Z","dependencies_parsed_at":"2024-04-07T02:39:51.471Z","dependency_job_id":"8f783e32-3180-4b4b-9c58-16a81af32e9f","html_url":"https://github.com/jwoglom/remarkable-substack","commit_stats":null,"previous_names":["jwoglom/remarkable-substack"],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwoglom%2Fremarkable-substack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwoglom%2Fremarkable-substack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwoglom%2Fremarkable-substack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwoglom%2Fremarkable-substack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwoglom","download_url":"https://codeload.github.com/jwoglom/remarkable-substack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514352,"owners_count":21920327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["remarkable-tablet"],"created_at":"2024-08-03T17:00:48.540Z","updated_at":"2025-12-25T05:29:12.316Z","avatar_url":"https://github.com/jwoglom.png","language":"Python","funding_links":[],"categories":["Cloud Tools"],"sub_categories":["Launchers"],"readme":"# remarkable-substack\n\nSyncs unread Substack posts onto your ReMarkable tablet.\n\n## How to run\n\nYou can run either via Docker or locally with Python + pipenv.\n\n### Docker\nWith `docker run`, use an invocation such as the following. Update the version number to the latest release.\n\n```bash\ndocker run -v ~/.rmapi:/home/appuser/.rmapi -v ~/.config/remarkable-substack:/home/appuser/.config/remarkable-substack  --rm -it ghcr.io/jwoglom/remarkable-substack/remarkable-substack:v0.3.9\n```\n\nNote the volume-mounted `.rmapi` folder from your home directory which is used to store the long-running remarkable session token, and the `.config/remarkable-substack` folder which stores the substack session token.\n\n### Pipenv\n```bash\ngit clone https://github.com/jwoglom/remarkable-substack\ncd remarkable-substack\npipenv install\npipenv run python3.py\n```\n\n\n## First-time setup\nThe first time you run remarkable-substack, you need to authenticate with both the ReMarkable Cloud and Substack.\n\n### Preparatory Task\nConfiguration data for the application is stored in a file - /home/appuser/.rmapi which must be created prior to running the steps below. If this file is not created first, the application may create it as a directory rather than a file on some systems which could lead to problems. If you get \"IsADirectoryError\", this is most likely the culprit. \n\nTo create this file, run the following command:\n```bash\ncd\ntouch .rmapi\n``` \n\n### Authenticating with ReMarkable\n\nGo to https://my.remarkable.com/device/desktop/connect and log in with your existing account.\nYou will be provided a verification code on this page.\nRun the application with the additional argument `--remarkable-auth-token=XXXXX`, substituting the token from this page.\n\nFor the examples above, this would look like either:\n```\ndocker run -v ~/.rmapi:/home/appuser/.rmapi -v ~/.config/remarkable-substack:/home/appuser/.config/remarkable-substack  --rm -it ghcr.io/jwoglom/remarkable-substack/remarkable-substack:v0.3.9 --remarkable-auth-token=XXXXX\npipenv run python3.py --remarkable-auth-token=XXXXX\n```\n\n### Authenticating with Substack\n\nAfter authenticating with ReMarkable, you'll need to log in to substack. Open an incognito window in your browser and log in to substack.com. Request a login link via email, and then provide that URL as `--substack-login-url=https://XXXXX`\n\n\nFor the examples above, this would look like either:\n```\ndocker run -v ~/.rmapi:/home/appuser/.rmapi -v ~/.config/remarkable-substack:/home/appuser/.config/remarkable-substack  --rm -it ghcr.io/jwoglom/remarkable-substack/remarkable-substack:v0.3.9 --substack-login-url=https://XXXXX\npipenv run python3.py --substack-login-url=https://XXXXX\n```\n\n## Configuration\nYou can tweak these additional parameters:\n\n```\nusage: main.py [-h] [--max-save-count MAX_SAVE_COUNT] [--max-fetch-count MAX_FETCH_COUNT] [--delete-already-read] [--delete-unread-after-hours DELETE_UNREAD_AFTER_HOURS] [--folder FOLDER] [--remarkable-auth-token REMARKABLE_AUTH_TOKEN]\n               [--substack-login-url SUBSTACK_LOGIN_URL] [--config-folder CONFIG_FOLDER] [--tmp-folder TMP_FOLDER]\n\nWrites recent Substack articles to reMarkable cloud\n\noptions:\n  -h, --help            show this help message and exit\n  --max-save-count MAX_SAVE_COUNT\n                        Maximum number of articles to save on device\n  --max-fetch-count MAX_FETCH_COUNT\n                        Maximum number of articles to fetch from Substack\n  --delete-already-read\n                        Delete articles in reMarkable cloud which are already read\n  --delete-unread-after-hours DELETE_UNREAD_AFTER_HOURS\n                        If an article has not been opened for this many hours on the device and there are new articles to add, will delete. Set to -1 to disable, or 0 to always replace old articles.\n  --folder FOLDER       Folder title to write to\n  --remarkable-auth-token REMARKABLE_AUTH_TOKEN\n                        For initial authentication with reMarkable: device token\n  --substack-login-url SUBSTACK_LOGIN_URL\n                        For initial authentication with reMarkable: device token\n  --config-folder CONFIG_FOLDER\n                        Configuration folder for remarkable-substack\n  --tmp-folder TMP_FOLDER\n                        Temporary storage folder for remarkable-substack\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwoglom%2Fremarkable-substack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwoglom%2Fremarkable-substack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwoglom%2Fremarkable-substack/lists"}