Skip to main content

A package used for finding, generating, and setting alt-text for images in HTML and EPUB files.

Project description

Alt-Text

A PyPi package used for finding, generating, and setting alt-text for images in HTML and EPUB files.

Getting Started

Installation

You can find the PyPi package here. To install the package via, you can execute the following in a terminal for your respective system...

Windows
py -m pip install alt-text

Unix/MacOS
python3 -m pip install alt-text

Developer Dependencies

All developer dependencies can be found here. You will only need to install these individually when working directly with the source code.

Engine Dependencies

As of the moment, the image analyzation tools that Alt-Text uses are not fully bundled with the package itself. Hence, depending on the type of engines you are using (for Description Generation and/or Character Recognition), you will need to install various applications/get API keys for the respective functionalities.

Description Engines

Description Engines are used to generate descriptions of an image. If you are to use one of these, you will need to fulfill that specific Engine's dependencies before use.

ReplicateMiniGPT4API

ReplicateMiniGPT4API Engine uses the Replicate API, hence you will need to get an API key via Logging in with Github on the Replicate website.

GoogleVertexAPI

GoogleVertexAPI Engine uses the Vertex AI API, hence you will need to get access from the Google API Marketplace. Additionally, Alt-Text uses Service Account Keys to get authenticated with Google Cloud, hence you will need to Create a Service Account Key with permission for the Vertex AI API and have its according JSON.

OCR Engines

Optical Character Recognition Engines are used to find text within images. If you are to use one of these, you will need to fulfill that specific Engine's dependencies before use.

Tesseract

The Tesseract Engine uses Tesseract, hence you will need to install the Tesseract OCR.

Quickstart & Usage

To be added...

Our Mission

The Alt-Text project is developed for the Free Ebook Foundation as a Senior Design Project at Stevens Institute of Technology.

As Ebooks become a more prominant way to consume written materials, it only becomes more important for them to be accessible to all people. Alternative text (aka alt-text) in Ebooks are used as a way for people to understand images in Ebooks if they are unable to use images as intended (e.g. a visual impaired person using a screen reader to read an Ebook).

While this feature exists, it is still not fully utilized and many Ebooks lack alt-text in some, or even all their images. To illustrate this, the Gutenberg Project, the creator of the Ebook and now a distributor of Public Domain Ebooks, have over 70,000 Ebooks in their collection and of those, there are about 470,000 images without alt-text.

The Alt-Text project's goal is to use the power of AI, Automation, and the Internet to craft a solution capable of automatically generating descriptions for images lacking alt-text in Ebooks, closing the accessibility gap and improving collections, such as the Gutenberg Project.

Contact Information

The emails and relevant information of those involved in the Alt-Text project can be found below.

The Deveolpers

The Client

Advisor

APIs, Tools, & Libraries Used

Alt-Text is developed using an assortment of modern Python tools...

Development Tools

Alt-Text is developed using...

APIs and Supplementary Tools

Packaging/Distribution Tools

Alt-Text is distributed using...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alt_text-0.2.3.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

alt_text-0.2.3-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file alt_text-0.2.3.tar.gz.

File metadata

  • Download URL: alt_text-0.2.3.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for alt_text-0.2.3.tar.gz
Algorithm Hash digest
SHA256 d070471f72e7d4ecceb85757da4655366a51a7505db98076fe1fbd74e5b35ff7
MD5 09b276463d606be16e2d6d4527ba65af
BLAKE2b-256 98b792d40d79a6dab9d0b4f831ec21389da33fa2eab40d73c59d779c2cca1629

See more details on using hashes here.

File details

Details for the file alt_text-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: alt_text-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for alt_text-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f34d834fd50471233a5bf25bce82ad95b6124bd819df10c0603d8ac71f039b36
MD5 1e74e40b018d82e8f3b4faa3db95920f
BLAKE2b-256 e4dd1937e7acd20704b1266641a19a142b0ef02f0bb14dfbce94cf986b23a23e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page