Metadata-Version: 2.1
Name: rf-httplibrary
Version: 3.0a2
Summary: HTTP Request Test Library.
Home-page: https://github.com/MainSystemDev/rf-httplibrary
Author: Shiela Buitizon
Author-email: shiela.buitizon@mnltechnology.com
License: Type license() to see the full license text
Platform: any
Classifier: Development Status :: 4 - Beta
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
Requires-Dist: requests-toolbelt (==0.9.1)
Requires-Dist: requests (==2.22.0)
Requires-Dist: jsonschema (==3.2.0)
Requires-Dist: jsonpath-rw (==1.4.0)
Requires-Dist: jsonpath-rw-ext (>=0.1.9)
Requires-Dist: urllib3 (>=1.25.11)

HttpLibrary
================



Authors:
* __Shiela Buitizon | email:shiela.buitizon@mnltechnology.com__
* __Joshua Kim Rivera | email:joshua.rivera@mnltechnology.com__

Company: [__Spiralworks Technologies Inc.__](http://www.spiralwrks.com/)


##### Contents:
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Keyword Documentation](#keyword-documentation)
- [Generating Local Documentation](#generating-local-documentation)
- [Execute Unit Test](#execute-unit-test)



### Introduction
**HttpLibrary** is test library for web services and restful api.

![PyPI](https://img.shields.io/pypi/v/rf-httplibrary?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dd/rf-httplibrary?style=for-the-badge)
![PyPI - License](https://img.shields.io/pypi/l/rf-httplibrary?style=for-the-badge)

### Installation

**Option 1**

Install this project using pypi, run:
```bash
pip install rf-httplibrary
```
**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/MainSystemDev/rf-httplibrary.git
```

### Usage
To use HttpLibrary in Robot Framework test(s), the library needs to
first be imported using the `Library` setting as any other library.

```robotframework
*** Settings ***
Documentation                           Simple example using HttpLibrary
Library                                 HttpLibrary

*** Test Cases ***
Test Case Sample One
    New Http Session
    Create Http Get Request             ${url}
    Add Http Request Parameter          ${paramkey1}        ${paramvalue1}
    Add Http Request Parameter          ${paramkey2}        ${paramvalue2}
    Invoke Http Request
    Http Raise For Status
    Close Http Session    
```

### Keyword Documentation  
View the latest keyword [documentation here](https://mainsystemdev.github.io/rf-httplibrary/) for more information about this library.


### Generating Local Documentation

To Generate the keyword Documentation, simply run:
```bash
python -m robot.libdoc HttpLibrary docs/index.html
```
Where: docs.html is the output file.
Note that the library must first be installed before generating a documentation.

### Execute Unit Test

```    
    python -m unittest
    python setup.py test
```

