{"id":18243843,"url":"https://github.com/khuei/lire","last_synced_at":"2025-07-28T02:07:34.453Z","repository":{"id":261072846,"uuid":"882842211","full_name":"khuei/lire","owner":"khuei","description":"TUI EPUB Reader","archived":false,"fork":false,"pushed_at":"2024-11-09T00:01:44.000Z","size":881,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-05T12:08:11.516Z","etag":null,"topics":["command-line","command-line-tool","epub","epub-reader","python","tui"],"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/khuei.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":"2024-11-03T22:21:58.000Z","updated_at":"2024-11-09T00:01:48.000Z","dependencies_parsed_at":"2024-12-22T08:40:29.049Z","dependency_job_id":"971d6746-30d5-4e8b-837b-1e5fe659e09b","html_url":"https://github.com/khuei/lire","commit_stats":{"total_commits":25,"total_committers":1,"mean_commits":25.0,"dds":0.0,"last_synced_commit":"b237ba3304ae28e7c2435245f95ac877c163f23b"},"previous_names":["khuei/lire"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/khuei/lire","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khuei%2Flire","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khuei%2Flire/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khuei%2Flire/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khuei%2Flire/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khuei","download_url":"https://codeload.github.com/khuei/lire/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khuei%2Flire/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267451489,"owners_count":24089312,"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","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["command-line","command-line-tool","epub","epub-reader","python","tui"],"created_at":"2024-11-05T09:03:32.238Z","updated_at":"2025-07-28T02:07:34.430Z","avatar_url":"https://github.com/khuei.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lire\n\n\u003e Lire /ˈlaɪ(ə)r/: to read\n\n\u003cimg src=\"./thumbnail.png\" alt=\"Thumbnail 1\" /\u003e\n\u003cimg src=\"./redacted.png\" alt=\"Thumbnail 2\" /\u003e\n\n## Features\n\n- **EPUB Parsing:** Reads and extracts text from EPUB files.\n- **Navigation:** Scroll through the text with arrow keys or `j/k` keys, jump by pages, and navigate between chapters.\n- **Text Redaction:** Manually blank out words you already read to keep track of progress.\n\n## Key Bindings\n\n- `UP` / `k`: Scroll up one line.\n- `DOWN` / `j`: Scroll down one line.\n- `LEFT` / `h`: Go to the previous chapter.\n- `RIGHT` / `l`: Go to the next chapter.\n- `f`: Scroll forward one page.\n- `b`: Scroll backward one page.\n- `n`: Move the redaction boundary forward (hiding one word).\n- `p`: Move the redaction boundary backward (Revealing last redacted word).\n- `SPACE`: Toggle redaction on/off.\n- `P`: Reset the redaction boundary.\n- `q`: Quit the reader.\n\n## Requirements\n\n- Python 3.6+\n- Required Python packages:\n  - `ebooklib`\n  - `beautifulsoup4`\n  - `argparse` (built-in module in most Python3 distributions)\n  - `curses` (built-in module in most Python distributions)\n\n## Usage\n\nRun the program with the following command:\n\n``` sh\n./lire \u003cpath_to_epub_file\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhuei%2Flire","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhuei%2Flire","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhuei%2Flire/lists"}