{"id":50214110,"url":"https://github.com/hugobatista/intellireading-api_server","last_synced_at":"2026-05-26T07:04:19.790Z","repository":{"id":273177263,"uuid":"852046736","full_name":"hugobatista/intellireading-api_server","owner":"hugobatista","description":"A fastapi server that exposes the Intellireading Library and the backend of the Intellireading website.","archived":false,"fork":false,"pushed_at":"2026-05-10T09:14:43.000Z","size":12944,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-10T20:11:32.004Z","etag":null,"topics":["adhd","bionic-reading","ebook","epub","kepub","kindle","kobo","speed-reading"],"latest_commit_sha":null,"homepage":"https://www.intellireading.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugobatista.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"hugobatista"}},"created_at":"2024-09-04T06:11:37.000Z","updated_at":"2026-05-10T09:14:47.000Z","dependencies_parsed_at":"2025-08-27T22:35:43.811Z","dependency_job_id":null,"html_url":"https://github.com/hugobatista/intellireading-api_server","commit_stats":null,"previous_names":["0x6f677548/intellireading-backend","0x6f677548/intellireading-api_server"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/hugobatista/intellireading-api_server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugobatista%2Fintellireading-api_server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugobatista%2Fintellireading-api_server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugobatista%2Fintellireading-api_server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugobatista%2Fintellireading-api_server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugobatista","download_url":"https://codeload.github.com/hugobatista/intellireading-api_server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugobatista%2Fintellireading-api_server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33508321,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T03:12:49.672Z","status":"ssl_error","status_checked_at":"2026-05-26T03:12:47.976Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["adhd","bionic-reading","ebook","epub","kepub","kindle","kobo","speed-reading"],"created_at":"2026-05-26T07:04:16.655Z","updated_at":"2026-05-26T07:04:19.781Z","avatar_url":"https://github.com/hugobatista.png","language":"Python","funding_links":["https://github.com/sponsors/hugobatista"],"categories":[],"sub_categories":[],"readme":"![Intellireading.com](https://go.hugobatista.com/ghraw/intellireading-www/main/public/img/intellireading.png)\n# API Server for Intellireading CLI\n\n[![PyPI - Version](https://img.shields.io/pypi/v/intellireading-cli.svg)](https://pypi.org/project/intellireading-cli)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/intellireading-cli.svg)](https://pypi.org/project/intellireading-cli)\n[![Deploy to GHCR](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/build-and-publish-to-ghcr.yml/badge.svg)](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/build-and-publish-to-ghcr.yml)\n[![GitHub - Lint](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/lint.yml/badge.svg)](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/lint.yml)\n[![GitHub - Test](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/test.yml/badge.svg)](https://go.hugobatista.com/gh/intellireading-api_server/actions/workflows/test.yml)\n\nIntellireading API server exposes the [Intellireading CLI Library](https://go.hugobatista.com/gh/intellireading-cli) through FastAPI. It is the backend of the [Intellireading site](https://intellireading.com/).\n\nExample of a text converted to a metaguided text:\n![Intellireading.com](https://go.hugobatista.com/ghraw/intellireading-www/main/src/img/sample.png) \n\n\nThis repo is part of the [Intellireading](https://intellireading.com/) project, which aims to help people with dyslexia, ADHD, or anyone who wants to improve their reading focus and speed. \n\n## [Other Intellireading Code Repositories](https://go.hugobatista.com/ghstars/lists/intellireading)\n- [Intellireading site](https://go.hugobatista.com/gh/intellireading-www), which allows anyone to convert an EPUB to the metaguided version.\n- [API Server](https://go.hugobatista.com/gh/intellireading-api_server), that support the Intellireading site.\n- [Command-Line tool](https://go.hugobatista.com/gh/intellireading-cli). A standalone tool and library that can be used to metaguide EPUB files.\n- [Calibre Plugins](https://go.hugobatista.com/gh/intellireading-calibre-plugins). A set of plugins that can be used to metaguide EPUB files using Calibre.\n\n\n## What is EPUB Metaguiding?\n**Metagu**iding **i**s **a** **techn**ique **th**at **ca**n **b**e **us**ed **t**o **impr**ove **yo**ur **read**ing **foc**us **an**d **spe**ed **(some**times **cal**led **Bio**nic **Readi**ng). **I**t **i**s **bas**ed **o**n **th**e **id**ea **th**at **yo**u **ca**n **us**e **a** **vis**ual **gui**de **t**o **he**lp **yo**ur **ey**es **foc**us **o**n **th**e **te**xt **yo**u **ar**e **read**ing. **I**n **th**is **cas**e, **th**e **vis**ual **gui**de **i**s **do**ne **b**y **bold**ing **a** **pa**rt **o**f **th**e **tex**t, **crea**ting **vis**ual **anch**ors **th**at **yo**ur **ey**es **ca**n **us**e **t**o **foc**us **o**n **th**e **tex**t. **Th**is **i**s **simi**lar **t**o **th**e **wa**y **a** **fin**ger **ca**n **b**e **us**ed **t**o **gui**de **yo**ur **ey**es **alo**ng **a** **li**ne **o**f **tex**t, **whi**ch **ha**s **be**en **sho**wn **t**o **impr**ove **read**ing **spe**ed **an**d **foc**us. ([**stu**dy: **\"Do**es **finger-t**racking **poi**nt **t**o **chi**ld **read**ing **strate**gies\"](https://ceur-ws.org/Vol-2769/paper_60.pdf))\n\n**Howe**ver, **unl**ike **a** **fing**er, **th**e **vis**ual **gui**de **i**s **no**t **distra**cting, **an**d **i**t **ca**n **b**e **us**ed **t**o **gui**de **yo**ur **ey**es **alo**ng **mult**iple **lin**es **o**f **te**xt **a**t **onc**e. **Th**is **all**ows **yo**u **t**o **re**ad **fast**er, **an**d **wi**th **le**ss **effo**rt.\n\n**Metagu**iding **i**s **partic**ulary **use**ful **fo**r **peo**ple **wi**th **dysl**exia **o**r **ADH**D, **bu**t **i**t **ca**n **b**e **us**ed **b**y **any**one **wh**o **wan**ts **t**o **impr**ove **the**ir **read**ing **foc**us **an**d **spe**ed. **Fo**r **mo**re **inform**ation, **vis**it **th**e [**Intelli**reading **webs**ite.](https://intellireading.com/)\n\n# Architecture\nThis project is also a playground for my FastAPI-bootstrap, which is a project template that includes a lot some best practices and tools that I use in my FastAPI projects. You can find more information about the bootstrap in the [FastAPI-bootstrap repository](https://go.hugobatista.com/gh/fastapi-bootstrap).\nA typical deployment would be composed of the following containers:\n- **api-proxy**: An NGINX server that acts as a reverse proxy for api-server (FastAPI). \n- **api-server**: A FastAPI server that exposes the Intellireading CLI library through a REST API and is instrumented with OpenTelemetry, sending traces, metrics, and logs to an otel-collector.\n- **otel_collector**: An OpenTelemetry collector that exposes syslog and otel endpoints to receive logs, traces, and metrics from the api-proxy and api-server and forwards them to a remote OTEL compliant backend, which may be Jaeger, Prometheus, New Relic, Datadog, or any other backend that supports the OpenTelemetry protocol.\n \n## Other components\nSome of the tools and libraries used in this project are:\n- **FastAPI**: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.\n- **Hatch**: A modern project, package, and virtual env manager for Python.\n- **OpenTelemetry**: A set of APIs, libraries, agents, and instrumentation to provide observability.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugobatista%2Fintellireading-api_server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugobatista%2Fintellireading-api_server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugobatista%2Fintellireading-api_server/lists"}