Skip to content

bonfry/erasmos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Erasmos

GitHub release (latest by date) GitHub license GitHub last commit

This project allows you to transform documents into listenable audio tracks. The project is designed to integrate various approaches for document analysis and audio conversion.

Installation

Clone the repository

git clone https://github.com/bonfry/erasmos.git

Install the Python project

cd erasmos
pip install .[cli] # only cli dependencies
pip install .[api] # only api dependencies
pip install .[all] # all dependencies

CLI

You can get a preview of the parsed document

erasmos preview <FILENAME>

Or convert it to an mp3 file in the same path as the input file

erasmos convert <FILENAME>

HTTP Server

You can start the FastAPI server

erasmos-server

The web APIs expose the following endpoints:

  • /document/preview: to preview the document
  • /document/convert: to convert the document to audio

Roadmap

The project is currently in a simplified preliminary version. It will be considered an incremental process where features will be added or improved with each version:

Initial version (v 0.0.1) ☑️

  • Initial project structure
  • Simplified parsing of Markdown documents
  • TTS implementation with Google TTS API

Increment 1

  • Multilingual support
  • Better Markdown nodes parsing

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages