Merge pull request #6 from EbookFoundation/dev-david

Updated README.md. Updated pyproject.toml. Added more to idep.sh.

README.md

@@ -4,6 +4,48 @@ A PyPi package used for finding, generating, and setting alt-text for images in
 
 ## Getting Started
 
+### Installation
+
+You can find the PyPi package [here](https://pypi.org/project/alt-text/). To install the package via, you can execute the following in a terminal for your respective system...
+
+Windows<br/>
+`py -m pip install alt-text`
+
+Unix/MacOS<br/>
+`python3 -m pip install alt-text`
+
+### Developer Dependencies
+
+All developer dependencies can be found [here](#development-tools). 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](https://replicate.com/), hence you will need to get an API key via [Logging in with Github](https://replicate.com/signin) on the Replicate website.
+
+##### GoogleVertexAPI
+
+GoogleVertexAPI Engine uses the [Vertex AI API](https://cloud.google.com/vertex-ai), hence you will need to get access from the [Google API Marketplace](https://console.cloud.google.com/marketplace/product/google/aiplatform.googleapis.com). Additionally, Alt-Text uses Service Account Keys to get authenticated with Google Cloud, hence you will need to [Create a Service Account Key](https://cloud.google.com/iam/docs/keys-create-delete#creating) 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](https://github.com/tesseract-ocr/tesseract), hence you will need to install the [Tesseract OCR](https://tesseract-ocr.github.io/tessdoc/Installation.html).
+
+## Quickstart & Usage
+
+To be added...
+
 ## 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/).
@@ -55,6 +97,16 @@ Alt-Text is developed using an assortment of modern Python tools...
 Alt-Text is developed using...
 
 - [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/)
+- [EbookLib](https://pypi.org/project/EbookLib/)
+- [Replicate](https://pypi.org/project/replicate/)
+- [Google-Cloud-AIPlatform](https://pypi.org/project/google-cloud-aiplatform/)
+- [PyTesseract](https://pypi.org/project/pytesseract/)
+
+### APIs and Supplementary Tools
+
+- [Replicate API](https://replicate.com/)
+- [Vertex AI API](https://cloud.google.com/vertex-ai)
+- [Tesseract](https://github.com/tesseract-ocr/tesseract)
 
 ### Packaging/Distribution Tools
 

idep.sh

@@ -1,2 +1,5 @@
 py -m pip install beautifulsoup4
-py -m pip install EbookLib
+py -m pip install EbookLib
+py -m pip install replicate
+py -m pip install google-cloud-aiplatform
+py -m pip install pytesseract

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "alt-text"
-version = "0.0.1"
+version = "0.1.0"
 authors = [
     { name = "Free Ebook Foundation", email = "[email protected]" },
     { name = "Jack Byrne", email = "[email protected]" },
@@ -22,7 +22,7 @@ description = "A package used for finding, generating, and setting alt-text for
 readme = "README.md"
 requires-python = ">=3.7"
 classifiers = [
-    "Development Status :: 2 - Pre-Alpha",
+    "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",