https://github.com/pcolby/aws-sdk-qt

AWS SDK for Qt
https://github.com/pcolby/aws-sdk-qt

aws aws-sdk qt qt5

Last synced: 3 months ago
JSON representation

AWS SDK for Qt

• Host: GitHub
• URL: https://github.com/pcolby/aws-sdk-qt
• Owner: pcolby
• License: gpl-3.0
• Created: 2013-09-22T06:48:18.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2023-12-16T00:01:17.000Z (about 1 year ago)
• Last Synced: 2024-10-13T01:28:52.175Z (4 months ago)
• Topics: aws, aws-sdk, qt, qt5
• Language: C++
• Homepage:
• Size: 217 MB
• Stars: 34
• Watchers: 11
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING.LESSER.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# QtAws

[![Build Status](https://github.com/pcolby/aws-sdk-qt/actions/workflows/build.yaml/badge.svg)](https://github.com/pcolby/aws-sdk-qt/actions/workflows/build.yaml)

[![Static Analysis](https://github.com/pcolby/aws-sdk-qt/actions/workflows/static.yaml/badge.svg)](https://github.com/pcolby/aws-sdk-qt/actions/workflows/build.yaml)

[![GitHub Release](https://img.shields.io/github/v/release/pcolby/aws-sdk-qt?include_prereleases&label=Release)](https://github.com/pcolby/aws-sdk-qt/releases/latest)

[![LGPLv3 License](https://img.shields.io/badge/License-LGPLv3-informational.svg)](https://www.gnu.org/licenses/lgpl-3.0.html)

QtAws is an *unnoficial* [AWS] SDK for [Qt].

The library is still in early stages of development, but already includes much

of the basic framework plumbing required for implementing asynchronous AWS

clients, including generic classes for managing the building of AWS requests

(including all five AWS signature types) and processing of AWS responses.

The first [0.1.0](https://github.com/pcolby/aws-sdk-qt/releases/tag/v0.1.0)

release included just the signature, endpoint and region classes.  But that

release was [100% documented](http://pcolby.github.io/aws-sdk-qt/0.1.0/api/annotated.html)

(including the [internal code](http://pcolby.github.io/aws-sdk-qt/0.1.0/internal/annotated.html))

and 100% [unit tested](http://pcolby.github.io/aws-sdk-qt/0.1.0/coverage/).

Work then progressed for the SQS client classes - the basics of which are in

place now (see the [0.2.0 pre-release](https://github.com/pcolby/aws-sdk-qt/releases/tag/v0.2.0)),

however that work was put on hold when Amazon released their official

[AWS SDK for C++](https://github.com/aws/aws-sdk-cpp "aws-sdk-cpp"), while this

project re-evaluated its value proposition, as well as a potential shift to

becoming a light Qt-based wrapper for Amazon's SDK (which was not deemed a good

fit in the end).

However, now that Amazon has made public the API descriptions used to

generate most of the C++ SDK, effort is now being put into a Qt-based code

generator that will create the bulk of the service client and model classes from

those API descriptions.

Note that the API descriptions do not cover things like the signature, endpoint

and region classes, which is where the bulk of the development effort has been

to date, making all the investment in this project so far still completely

worthwhile :)

## Requirements

### Qt 5.1+

QtAws requires Qt 5.1 or later, as the library makes use of Qt's

QMessageAuthenticationCode class for generating HMAC codes for AWS request

signatures, and that class was first added in Qt 5.1.0.

Backporting QMessageAuthenticationCode to Qt 5.0 is [relatively simple](

https://github.com/pcolby/aws-sdk-qt/blob/196b5cd5e571d6883d288705234770a5e606d1f0/.travis.yml#L34),

but outside the scope of this project.

Note, the [code-generation](code-generation) sub-project requires Qt

5.10+ and [Grantlee](https://github.com/steveire/grantlee), but this is

for development of the SDK itself, not for developers that use the SDK.

## Building

This library supports out-of-source builds (highly recommended), for example:

~~~{.sh}

cmake -E make_directory 

cmake -D CMAKE_BUILD_TYPE=Release -S  -B 

cmake --build 

#make check

~~~

## API Documentation

See the [API documentation](http://pcolby.github.io/aws-sdk-qt/head/api/qtaws-index.html).

There's also [internal documentation](http://pcolby.github.io/aws-sdk-qt/head/internal/qtaws-index.html)

for anyone interested in the internal library implementation.

## Test Coverage

See the [test coverage report](http://pcolby.github.io/aws-sdk-qt/head/coverage/).

[AWS]: https://aws.amazon.com/ "Amazon Web Services"

[Qt]: https://www.qt.io/ "Qt Cross-platform Devleopment Framework"