Metadata-Version: 2.1
Name: robotframework-captchalibrary
Version: 1.0a3
Summary: Test Library for decoding base64 captchas to string format.
Home-page: https://github.com/joshuariveramnltech/captchalibrary
Author: Joshua Kim Rivera
Author-email: joshuakimrivera@gmail.com
License: Type license() to see the full license text
Description: CaptchaLibrary
        ================
          
        Library Scope: __GLOBAL__  
        
        Author: __Joshua Kim Rivera | email:joshuakimrivera@gmail.com__
        
        
        
        ##### Contents:
        - [CaptchaLibrary](#captchalibrary)
            - [Contents](#contents)
            - [Introduction](#introduction)
            - [Installation](#installation)
            - [Usage](#usage)
            - [Generating Documentation](#generating-documentation)
            - [Dependencies](#dependencies)
        
         
        
        ### Introduction
        **CaptchaLibrary** is a [Robotframework](https://www.robotframework.org) Test Library for decoding Captchas.  
        ![PyPI](https://img.shields.io/pypi/v/robotframework-captchalibrary?style=for-the-badge) 
        ![PyPI - Downloads](https://img.shields.io/pypi/dd/robotframework-captchalibrary?style=for-the-badge)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-captchalibrary?style=for-the-badge)
          
        View the latest keyword [Documentation here.](https://joshuariveramnltech.github.io/captchalibrary/)
        
        ### Installation
        **Option 1**  
        Install using pypi, run:
        ```bash
        pip install robotframework-captchalibrary
        ```
        **Option 2**  
        With recent version of `pip`, it is possible to install directly from GitHub repository. To Install latest source
        from the master branch, use this command:
        ```bash
        pip install git+https://github.com/joshuariveramnltech/captchalibrary.git
        ```
        Please note that installation will take some time, because ``pip`` will
        clone the [CaptchaLibrary](https://github.com/joshuariveramnltech/captchalibrary) project to a temporary directory and then
        perform the installation.
        
        
        ### Usage
        To use CaptchaLibrary in Robot Framework tests, the library needs to
        first be imported using the `Library` setting as any other library.
        It is important to Note that CaptchaLibrary requires the serviceUrl as parameter
        upon import, see example below.
        
        ```robotframework
        *** Settings ***
        Documentation               Simple example using CaptchaLibrary
        Library                     CaptchaLibrary          serviceUrl=sample.captcha.service.url
        
        *** Variables ***
        ${sample_variable}
        
        *** Test Cases ***
        Test Case Sample One
            ${captcha}              Decode Base64 Captcha           path/to/image
            Log To Console          ${captcha}
        
        ```
        
        ### Generating Documentation
        To Generate the keyword Documentation, simple run:
        ```bash
        python -m robot.libdoc CaptchaLibrary documentation.html
        ```
        Note that the library must first be installed before generating a documentation.
        
        
        ### Dependencies
        * [Requests](https://pypi.org/project/requests/)
        * [Pillow](https://pypi.org/project/Pillow/)
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Description-Content-Type: text/markdown
