Add and/or changed information in README.md and pyproject.toml. Renamed file structure in '/src'.

pull/4/head
XxMistaCruzxX 2023-10-17 17:35:59 -04:00
parent 8758510445
commit d82184ceed
4 changed files with 52 additions and 5 deletions

View File

@ -1,9 +1,51 @@
# Alt-Text
## Who are we?
A PyPi package used for finding, generating, and setting alt-text for images in HTML and EPUB files.
## Getting Started
## Our Mission
The Alt-Text project is developed for the [Free Ebook Foundation](https://ebookfoundation.org/) as a Senior Design Project at [Stevens Institute of Technology](https://www.stevens.edu/).
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](https://gutenberg.org/), 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 170,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](https://gutenberg.org/).
### Contact Information
The emails and relevant information of those involved in the Alt-Text project can be found below.
#### The Deveolpers
- Jack Byrne
- jbyrne4@stevens.edu
- David Cruz
- da.cruz@aol.com
- [David's Website](https://xxmistacruzxx.github.io/)
- [David's Github](https://github.com/xxmistacruzxx)
- [David's LinkedIn](https://www.linkedin.com/in/davidalexandercruz/)
- Jared Donnelly
- jdonnel3@stevens.edu
- Ethan Kleschinsky
- ekleschi@stevens.edu
- Tyler Lane
- tlane@stevens.edu
- Carson Lee
- clee27@stevens.edu
#### The Client
- Eric Hellman
- eric@hellman.net
#### Advisor
- Aaron Klappholz
- aklappho@stevens.edu
## APIs, Tools, & Libraries Used
Alt-Text is developed using an assortment of modern Python tools...

View File

@ -3,9 +3,10 @@ requires = ["hatchling", "beautifulsoup4"]
build-backend = "hatchling.build"
[project]
name = "alt_text"
name = "alt-text"
version = "0.0.1"
authors = [
{ name = "Free Ebook Foundation", email = "eric@ebookfoundation.org" },
{ name = "Jack Byrne", email = "jbyrne4@stevens.edu" },
{ name = "David Cruz", email = "dcruz2@stevens.edu" },
{ name = "Jared Donnelly", email = "jdonnel3@stevens.edu" },
@ -14,17 +15,21 @@ authors = [
{ name = "Carson Lee", email = "clee27@stevens.edu" },
]
maintainers = [
{ name = "David Cruz", email = "dcruz2@stevens.edu" },
{ name = "Eric Hellman", email = "eric@hellman.net" },
{ name = "David Cruz", email = "dcruz2@stevens.edu" },
]
description = "A package used for finding, generating, and setting alt-text for images in HTML and EPUB files."
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 3",
"Development Status :: 2 - Pre-Alpha",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
]
[project.urls]
"Homepage" = "https://github.com/EbookFoundation/alt-text"
"Source" = "https://github.com/EbookFoundation/alt-text"
"PyPi" = "https://pypi.org/project/alt-text/"
"Free Ebook Foundation" = "https://ebookfoundation.org/"