{"id":15432750,"url":"https://github.com/gugarosa/ghost_reader","last_synced_at":"2025-07-03T22:07:39.057Z","repository":{"id":98631801,"uuid":"320055343","full_name":"gugarosa/ghost_reader","owner":"gugarosa","description":"👻 An image-to-text and text-to-voice application focused on accessibility.","archived":false,"fork":false,"pushed_at":"2022-10-05T12:18:51.000Z","size":109,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-18T07:39:50.824Z","etag":null,"topics":["application","backend","image-to-text","python","text-to-voice"],"latest_commit_sha":null,"homepage":"","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/gugarosa.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":"2020-12-09T19:13:46.000Z","updated_at":"2024-08-09T16:01:31.000Z","dependencies_parsed_at":"2023-03-07T10:30:48.343Z","dependency_job_id":null,"html_url":"https://github.com/gugarosa/ghost_reader","commit_stats":{"total_commits":38,"total_committers":1,"mean_commits":38.0,"dds":0.0,"last_synced_commit":"81cf6d6c258c47fcd874bdc9903672296c0839b0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gugarosa/ghost_reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fghost_reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fghost_reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fghost_reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fghost_reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gugarosa","download_url":"https://codeload.github.com/gugarosa/ghost_reader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fghost_reader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263410776,"owners_count":23462299,"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":["application","backend","image-to-text","python","text-to-voice"],"created_at":"2024-10-01T18:28:29.788Z","updated_at":"2025-07-03T22:07:39.030Z","avatar_url":"https://github.com/gugarosa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ghost Reader: Autonomously Reading Images and Texts\n\n## Welcome to Ghost Reader.\n\nAn easy-to-use solution for extracting text from images and further converting them into raw audios. Ghost Readers offers a high-level API where requests can be made via JSON to accomplish such features. Please, follow along with the next sections in order to learn more about this excellent tool.\n\nGhost Reader is compatible with: **Python 3.6+**.\n\n---\n\n## Package guidelines\n\n1. The very first information you need is in the very **next** section.\n2. **Installing** is also easy if you wish to read the code and bump yourself into, follow along.\n3. Note that there might be some **additional** steps in order to use our solutions.\n4. If there is a problem, please do not **hesitate**. Call us.\n\n---\n\n## Getting started: 60 seconds with Ghost Reader\n\nFirst of all. Code is commented. Yes, everything is commented. Just browse to any file, chose your subpackage, and follow it. We have high-level code for most tasks we could think.\n\nAlternatively, if you wish to learn even more, please take a minute:\n\nGhost Reader source files are based on the following structure, and you should pay attention to its tree:\n\n```yaml\n- ghost_reader\n    - decorators\n        - authentication\n    - handlers\n        - base\n        - convert\n        - extract\n        - login\n        - register\n    - models\n        - conversion\n        - extraction\n        - user\n    - processors\n        - base\n        - convert\n        - extract\n    - utils\n        - constants\n        - database\n        - loader\n        - process_manager\n        - server\n        - speecher\n```\n\n### Decorators\n\nEach decorator is responsible for performing additional verifications that must be made before computing requests.\n\n### Handlers\n\nA package that is used to handle any route within this API.\n\n### Models\n\nModels are NoSQL definitions used to persist data across interactions.\n\n### Processors\n\nThe processors are responsible for invoking and consuming the task queues, providing a callback when the task has been invoked, consumed, and finished.\n\n### Utils\n\nA utility package stands for everyday things shared across the application. It is better to implement once and use it as you wish than re-implementing the same thing repeatedly.\n\n---\n\n## Installation\n\nRemember that you need to adjust `.env.example` according to your needs and make sure that `docker-compose` is installed and accessible from the command line.\n\n### Docker-Compose\n\nFirst of all, you need to build the container's image, as follows:\n\n```\ndocker-compose build\n```\n\nAfter the build process is finished, you can run the container in detached mode:\n\n```\ndocker-compose up -d\n```\n\nIf you ever need to perform maintenance or update the repository, please put the container down:\n\n```\ndocker-compose down\n```\n\n---\n\n## Environment configuration\n\nNote that sometimes, there is a need for additional implementation. If needed, from here, you will be the one to know all of its details.\n\n### Ubuntu\n\nNo specific additional commands are needed.\n\n### Windows\n\nNo specific additional commands are needed.\n\n### MacOS\n\nNo specific additional commands are needed.\n\n---\n\n## Support\n\nWe know that we do our best, but it is inevitable to acknowledge that we make mistakes. If you ever need to report a bug, report a problem, talk to us, please do so! We will be available at our bests at this repository.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgugarosa%2Fghost_reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgugarosa%2Fghost_reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgugarosa%2Fghost_reader/lists"}