Metadata-Version: 2.1
Name: robotframework-aws
Version: 0.1.0
Summary: A python package to test AWS services in Robot Framework
Home-page: https://github.com/MarketSquare/robotframework-aws
Author: Dillan Teagle
Author-email: softwaredeveloper@dillanteagle.me
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Description-Content-Type: text/markdown
License-File: LICENSE

# robotframework-aws

AWSLibrary is a testing library for Robot Framework that gives you the ability to use many of the AWS services in your 
tests. This library directly interacts with [Boto 3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html).  
Boto is the Amazon Web Services (AWS) SDK for Python. It enables Python developers to create, configure, and manage 
AWS services.

If there is functionality that should be included in this library please create an issue or feel free to contribute.

![PyPI](https://img.shields.io/pypi/v/robotframework-aws.svg)
![Last Commit](https://img.shields.io/github/last-commit/MarketSquare/robotframework-aws)
![License](https://img.shields.io/pypi/l/robotframework-aws)
![Downloads](https://img.shields.io/pypi/dm/robotframework-aws)
![Total downloads](https://static.pepy.tech/personalized-badge/robotframework-aws?period=total&units=international_system&left_color=lightgrey&right_color=yellow&left_text=Total)

## Keyword Documentation

---------------

This library covers the AWS services listed in the keywords:

[Documentation of keywords](https://raw.githack.com/MarketSquare/robotframework-aws/master/docs/AWSLibrary.html)

[Pypi](https://pypi.org/project/robotframework-aws/)

---------------

### Installation and use

#### Install the package

```sh
pip install robotframework-aws
```

#### Update the package

```sh
pip install robotframework-aws --updagrade
```

#### Creating a Test Case

When creating a test case, start by creating an AWS session for your test and end by deleting it.

```robotframework
*** Settings ***
Library  AWSLibrary


*** Variables ***
${REGION}    eu-west-1
${BUCKET}    some-bucket-name


*** Test Cases ***
Test Case
    [Setup]    Create Session With Keys    ${REGION}    %{AWS_USER_NAME}    %{AWS_USER_PASS}
    S3 Upload File    ${BUCKET}    new_file.json    ${CURDIR}/local_file.json
    S3 Key Should Exist    ${BUCKET}    new_file.json
    S3 Key Should Not Exist    ${BUCKET}    local_file.json
    ${file_inside_folder}    S3 List Objects    ${BUCKET}    folder_name
    Log List   ${file_inside_folder}
    S3 Download File    ${BUCKET}    new_file.json    ${CURDIR}/new_local_file.json
    S3 Delete File    ${BUCKET}    new_file.json
    [Teardown]    Delete All Sessions
```

### Attention Contributors

The project development contribution session and local testing with "localstack" is under construction and needs to be 
reviewed, contributions are welcome.

  [Contribution guidelines for this project](CONTRIBUTING.md)


