{"id":13596136,"url":"https://github.com/agrmohit/omnivore-epub","last_synced_at":"2025-04-06T03:09:44.420Z","repository":{"id":193747287,"uuid":"689273775","full_name":"agrmohit/omnivore-epub","owner":"agrmohit","description":"A program to generate epub file from articles saved in your Omnivore library and optionally send it to your eReader using email","archived":false,"fork":false,"pushed_at":"2024-10-31T14:14:29.000Z","size":51,"stargazers_count":106,"open_issues_count":2,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T02:07:09.091Z","etag":null,"topics":["deno","epub-generator","kindle","omnivore","omnivore-api","pocketbook","read-it-later"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/agrmohit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-09-09T09:47:18.000Z","updated_at":"2025-03-29T00:17:56.000Z","dependencies_parsed_at":"2023-09-09T19:52:05.079Z","dependency_job_id":"5bd21459-2d1f-4e6e-b570-7272882cab30","html_url":"https://github.com/agrmohit/omnivore-epub","commit_stats":{"total_commits":53,"total_committers":4,"mean_commits":13.25,"dds":0.07547169811320753,"last_synced_commit":"1c60b701edcd7a30fbc51619a3b3f6315a9f84a6"},"previous_names":["agrmohit/omnivore-epub"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrmohit%2Fomnivore-epub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrmohit%2Fomnivore-epub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrmohit%2Fomnivore-epub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrmohit%2Fomnivore-epub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agrmohit","download_url":"https://codeload.github.com/agrmohit/omnivore-epub/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427006,"owners_count":20937201,"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":["deno","epub-generator","kindle","omnivore","omnivore-api","pocketbook","read-it-later"],"created_at":"2024-08-01T16:02:09.417Z","updated_at":"2025-04-06T03:09:44.404Z","avatar_url":"https://github.com/agrmohit.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Omnivore EPUB\n\n\u003c!-- Badges start --\u003e\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/agrmohit/omnivore-epub)](https://github.com/agrmohit/omnivore-epub)\n[![Gitea Stars](https://img.shields.io/gitea/stars/agrmohit/omnivore-epub?gitea_url=https%3A%2F%2Fcodeberg.org\u0026logo=codeberg)](https://codeberg.org/agrmohit/omnivore-epub)\n[![GitHub Release](https://img.shields.io/github/v/release/agrmohit/omnivore-epub)](https://github.com/agrmohit/omnivore-epub/releases)\n[![License](https://img.shields.io/badge/license-MIT-informational)](LICENSE)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/agrmohit/omnivore-epub)\n[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)\n\n\u003c!-- Badges end --\u003e\n\n\u003e [!CAUTION]\n\u003e Unfortunately, Omnivore is [shutting down](https://blog.omnivore.app/p/omnivore-is-joining-elevenlabs) and all data\n\u003e will be deleted on 15th November 2024. Please export your data by then. Omnivore will remain open-source and can still\n\u003e be self-hosted. This program should continue to work with self-hosted instances.\n\u003e\n\u003e For people looking to migrate, personally I would recommend [Readeck](https://readeck.org/en/) which is a great FOSS\n\u003e alternative though it is missing a few features. [Readwise Reader](https://readwise.io/read) is another good one but\n\u003e its paid and not open source. Both offer ways to import Omnivore data.\n\u003e\n\u003e I am not affiliated with the Omnivore project in any way.\n\nA program to generate epub file from articles saved in your [Omnivore](https://omnivore.app) library and optionally send\nit to your eReader using email.\n\nOmnivore is an open source read-it-later app similar to Pocket and Instapaper.\n\nForked from [here](https://gist.github.com/kebot/90de9c41742cacf371368d85870c4a75)\n\n## OS Support\n\nThis program uses no OS specific code and should work on all platforms supported by `Deno`.\n\n## Download\n\n- To download the latest version of the program, you can use git to clone the repository\n- If you are not familiar with git, you can always download the latest version by going to\n  [the latest GitHub release](https://github.com/agrmohit/omnivore-epub/releases/latest)\n- Then, under `Assets` click on `Source code (zip)` which will download the latest release of the program in a zip file\n  which you will need to unzip.\n- The program checks for updates when run and will notify you of new releases when available. This can be disabled in\n  the config file.\n\n## Usage\n\n- Install [Deno](https://deno.com/manual/getting_started/installation)\n- Get an API token for Omnivore following instructions\n  [here](https://docs.omnivore.app/integrations/api.html#getting-an-api-token)\n- Put your token in the `token` field in [config file](config.json)\n- Modify the configuration file if necessary\n- In your terminal, go to the app folder and run the following command `deno run -A main.ts`\n- The ebook with extension `.epub` should be in the app directory after execution\n\n### Send to eReader\n\nList of eReaders that support sending ebook using email:\n\n- [Kindle](https://www.amazon.com/sendtokindle/email)\n- [Pocketbook](https://www.youtube.com/watch?v=lFfWwzi8WEM)\n\n\u003e [!TIP]\n\u003e\n\u003e Make sure the email address used is approved to send ebook to your eReader\n\n#### Configuring email\n\n- Ability to send ebook over email is disabled by default\n- To enable it, set `emailSupport` to `true` in the [config file](config.json)\n- Set `emailHost` to the [SMTP](https://www.cloudflare.com/en-in/learning/email-security/what-is-smtp/) address of your\n  email provider\n- E.g. `smtp.gmail.com` for Gmail and `smtp-mail.outlook.com` for Outlook\n- Set `emailPort` to the SMTP Port. Usually it is 587, 465 or 25\n- Set `emailUser` which is usually your email address\n- Set `emailPassword` to your email account password. This is stored locally on your device and is never sent to us\n- Set `emailRecipient` to the email you want to receive ebook on (your eReader's email address). See the links in list\n  of eReaders above to know more\n- You may need to set `emailAllowSTARTTLS` to false when using `465` as `emailPort`. Leave it to `true` when not sure\n\n\u003e [!CAUTION]\n\u003e\n\u003e The email password is stored in plaintext on your device, unencrypted. Therefore, it is highly recommended to use app\n\u003e password instead of your account password whenever your email provider supports it\n\u003e\n\u003e You may also need to turn on 2FA (Two Factor Authentication)\n\u003e\n\u003e Instructions for setting an app password for a few popular email providers:\n\u003e\n\u003e - [Gmail](https://support.google.com/accounts/answer/185833)\n\u003e - [Outlook](https://support.microsoft.com/en-us/account-billing/5896ed9b-4263-e681-128a-a6f2979a7944)\n\u003e - [Zoho Mail](https://help.zoho.com/portal/en/kb/bigin/channels/email/articles/generate-an-app-specific-password)\n\n## Configuration\n\nConfiguration options available in the [config file](config.json)\n\n| Option                   | Type     | Description                                              |\n| ------------------------ | -------- | -------------------------------------------------------- |\n| token                    | string   | Omnivore API Token                                       |\n| endpoint                 | string   | Omnivore GraphQL API endpoint                            |\n| title                    | string   | Title of the ebook                                       |\n| author                   | string   | Author of the ebook                                      |\n| cover                    | string   | URL for fetching cover image for the ebook               |\n| description              | string   | Description of the ebook                                 |\n| addLabelsInContent       | boolean  | Whether to add the labels for the article below title    |\n| addArticleLinkInContent  | boolean  | Whether to add the link for the article below title      |\n| allowImages              | boolean  | Whether to add images linked in article in the ebook     |\n| outputFileName           | string   | ebook file name                                          |\n| maxArticleCount          | number   | Number of articles to fetch                              |\n| searchQuery              | string   | Valid query for article search                           |\n| ignoredLabels            | string[] | List of labels to exclude from the ebook                 |\n| ignoredLinks             | string[] | List of urls to exclude from the ebook                   |\n| emailSupport             | boolean  | Whether to send the ebook via email (to your eReader)    |\n| emailHost                | string   | SMTP Hostname of your email provider                     |\n| emailPort                | number   | Usually one of 587, 465 or 25. Prefer 587 when available |\n| emailUser                | string   | Username/Email address of your email account             |\n| emailPassword            | string   | Password of your email account. Prefer app password      |\n| emailRecipient           | string   | Email address that should receive your ebook             |\n| emailFrom                | string   | Sender name that appears to the email receiver           |\n| emailAllowSTARTTLS       | boolean  | Allow connecting to the SMTP server using STARTTLS       |\n| emailSizeWarningSuppress | boolean  | Show a warning if ebook is over emailSizeWarningMinSize  |\n| emailSizeWarningMinSize  | number   | Min ebook size to show warning while sending email in MB |\n| updateCheck              | boolean  | Check for updates when run                               |\n| showReleaseNotes         | boolean  | Show release notes when an update is available           |\n\n### Custom searchQuery\n\nSetting `searchQuery` is the recommended way to filter and sort articles. You can learn more about how to use them on\nthe official Omnivore documentation [Search | Omnivore Docs](https://docs.omnivore.app/using/search.html).\n\nThe default value is `sort:saved-desc` which returns all unarchived articles sorted by saved date, recently added\narticles first.\n\nYou can also use it to filter by labels. In case the label contain a space, you will need to escape the double-quotes\nusing a forward slash `\\`. Example: `sort:saved-desc label:\\\"Send to Kindle\\\"`\n\n## Star History\n\n\u003ca href=\"https://star-history.com/#agrmohit/omnivore-epub\u0026Date\"\u003e\n \u003cpicture\u003e\n   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=agrmohit/omnivore-epub\u0026type=Date\u0026theme=dark\" /\u003e\n   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=agrmohit/omnivore-epub\u0026type=Date\" /\u003e\n   \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=agrmohit/omnivore-epub\u0026type=Date\" /\u003e\n \u003c/picture\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagrmohit%2Fomnivore-epub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagrmohit%2Fomnivore-epub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagrmohit%2Fomnivore-epub/lists"}