Metadata-Version: 2.1
Name: alternat
Version: 0.0.3
Summary: Alternat is a tool that automates alt text generation.
Home-page: https://github.com/keplerlab/alternat.git
Author: keplerlab
Author-email: keplerwaasi@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://alternat.readthedocs.io
Project-URL: Source, https://github.com/keplerlab/alternat
Project-URL: Tracker, https://github.com/keplerlab/alternat/issues
Description: ## **alternat**: Automate your image alt-text generation workflow.
        ### Resources 
        * Homepage and Reference: <https://alternat.readthedocs.io/>
        
        ### Description
        alternat automates the image alt-text generation workflow by offering ready to use methods for downloading (Collection in alternat lingo) images and then generating alt-text.
        
        alternat features are grouped into tasks - Collection and Generation
        
        **Collection**
        
        Collection offers convenience methods to download images. It uses puppeteer (headless chrome) to automate the website crawling and image download process  
        
        **Generation**
        
        Generation offers convenience methods to generate alt-texts. It offers drivers to generate the alt-texts.
        1. Azure API - Uses Azure API for image captioning and OCR. Note Azure is a paid service.
        2. Google API - Uses google API for image captioning and OCR. Note google is a paid service.
        3. Open Source - Uses free open source alternative for OCR.
        
        **Supported Video and image file formats**
        jpeg, jpg and png are supported.
        
        ## Installation
        
        ### Using pypi
        
        1) Install node (>=v.12)
        2) Install Python >= 3.8 
        3) pip install alternat
        
        
        ### Install from source
        1) Install git
        2) Install node (>=v.12)
        3) Install python >= 3.8
        4) Open terminal or command prompt 
        5) Clone repo from here https://github.com/keplerlab/alternat.git 
        6) Change the directory to the directory where you have cloned your repo 
            ```
            $cd path_to_the_folder_repo_cloned
            ```
        ##### Mac and Linux
        7) Run the setup if alternat to be used as standalone application:
            ``` 
            sh install_application_mode.sh 
            ```
        
           Run the setup if alternat to be used as service:
            ``` 
            sh install_api_mode.sh 
            ``` 
        
        ### Installation using Docker
        1. Download and Install Docker Desktop for Mac using this link [docker-desktop](https://www.docker.com/products/docker-desktop)
        
        2. Clone this repo https://github.com/keplerlab/alternat.git 
        
        3. Change your directory to your cloned repo.
        
        4. Open terminal and run following commands
        ```
        cd <path-to-repo> //you need to be in your repo folder
        docker-compose build
        ```
        5. Start docker container using this command
        ```
        docker-compose up
        ```
        6. In a new terminal window open terminal inside docker container for running alternat using command line type following command:
        ```
        docker-compose exec alternat bash
        ```
        ### Installation using Anaconda python
        
        1. Install node (>=v.12) 
        2. Create conda environment and install dependencies using environment.yml file
        
        ```
        conda env create -f environment.yml
        ```
        
        3. If you want to do image downloads from websites (collect step in alternat) using apify pupeeter you need to also first install nodejs and then goto folder apify. Run npm install:
        ```
        cd <repo_path>
        cd alternat/collection/apify
        npm install
        ```
        
        ## Running generate task using command line:
        
        If you want to generate alternate text for any image or folder containing 
        multiple images, you can use Command line option which we call generation stage. 
        
        To run generation stage alone you can use following command: 
        
        ```
        # To run a single file, results will be collected under "results/generate"
        # The image extensions supported are: .jpg, .jpeg, .png.
        
        python app.py generate --output-dir-path="./results" --input-image-file-path="./sample/images_with_text/sample1.png"  
        
        or
        
        # To run for entire directory, results will be collected under "results/generate"
        # The image extensions supported are: .jpg, .jpeg, .png.
        
        python app.py generate --input-dir-path="./sample/images_with_text" --output-dir-path="./results"
        
        or 
        
        # To generate alt-text using specific driver (like azure, google or open source)
        # Do not forget to add the credentials to their respective config files when using azure and google
        # azure needs SUBSCRIPTION_KEY and ENDPOINT URL
        # google needs ABSOLUTE_PATH_TO_CREDENTIALS_FILE (a credential json file)
        
        python app.py generate --output-dir-path="./results" --input-image-file-path="./sample/images_with_text/sample1.png" --driver-config-file-path="./sample/generator_driver_conf/azure.json"
        
        ```
        
        
        
        Sample images are located at sample/images and sample/images_with_text
        
        ## Running collect task using command line:
        First stage is called collection stage, it can be used to crawl and download images from any website or website url, to run the collection stage use following commands:
        
        ### Use case: Download image from single page 
        ```bash
            # To run the collection 
            python app.py collect --collect-using-apify <WEBSITE_URL> ./DATADUMP
        ```
        
        ### Use case: Download images recursively for a given site
        
        ```bash
            # To run the collection 
            python app.py collect --collect-using-apify --download-recursive <WEBSITE_URL> ./DATADUMP
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
