Repository files navigation

Intellireading API server exposes theIntellireading CLI Library through FastAPI. It is the backend of theIntellireading site.

Example of a text converted to a metaguided text:

This repo is part of theIntellireading project, which aims to help people with dyslexia, ADHD, or anyone who wants to improve their reading focus and speed.

• Intellireading site, which allows anyone to convert an EPUB to the metaguided version.
• API Server, that support the Intellireading site.
• Command-Line tool. A standalone tool and library that can be used to metaguide EPUB files.
• Calibre Plugins. A set of plugins that can be used to metaguide EPUB files using Calibre.

Metaguidingisatechniquethatcanbeusedtoimproveyourreadingfocusandspeed(sometimescalledBionicReading).Itisbasedontheideathatyoucanuseavisualguidetohelpyoureyesfocusonthetextyouarereading.Inthiscase,thevisualguideisdonebyboldingapartofthetext,creatingvisualanchorsthatyoureyescanusetofocusonthetext.Thisissimilartothewayafingercanbeusedtoguideyoureyesalongalineoftext,whichhasbeenshowntoimprovereadingspeedandfocus. (study:"Doesfinger-trackingpointtochildreadingstrategies")

However,unlikeafinger,thevisualguideisnotdistracting,anditcanbeusedtoguideyoureyesalongmultiplelinesoftextatonce.Thisallowsyoutoreadfaster,andwithlesseffort.

MetaguidingisparticularyusefulforpeoplewithdyslexiaorADHD,butitcanbeusedbyanyonewhowantstoimprovetheirreadingfocusandspeed.Formoreinformation,visittheIntellireadingwebsite.

This 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 theFastAPI-bootstrap repository.A typical deployment would be composed of the following containers:

• api-proxy: An NGINX server that acts as a reverse proxy for api-server (FastAPI).
• 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.
• 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.

Some of the tools and libraries used in this project are:

• FastAPI: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
• Hatch: A modern project, package, and virtual env manager for Python.
• OpenTelemetry: A set of APIs, libraries, agents, and instrumentation to provide observability.