Metadata-Version: 2.1
Name: gdata-vaas
Version: 0.6.0
Summary: gdata-vaas is a Python library for the VaaS-API.
Home-page: https://github.com/GDATASoftwareAG/vaas/tree/main/python
Author: G DATA CyberDefense AG
Author-email: oem@gdata.de
Project-URL: Bug Tracker, https://github.com/GDATASoftwareAG/vaas/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# gdata-vaas

An SDK to easily utilize G DATA VaaS. 

*Verdict-as-a-Service* (VaaS) is a service that provides a platform for scanning files for malware and other threats. It allows easy integration in your application. With a few lines of code, you can start scanning files for malware. 

    ATTENTION: This library is currently under heavy construction!

## What does the SDK do?

It gives you as a developer a functions to talk to G DATA VaaS. It wraps away the complexity of the API into 2 basic functions.

### for_sha256
If you calculate the sha256 for a file, you can request that sha256 against G DATA VaaS. It's the fastest way to get a verdict from our service.

### for_file
You can also ask for a file itself. You will still get the benefit of a fast verdict via Sha256 because the SDK will do that for you first. But additionally, if we don't know the file, the file will get uploaded and (automatically) analyzed by us.

## How to use

### Install

```bash
pip3 install gdata-vaas
```

### Import
```python
from vaas import Vaas
```

### Example: Request a verdict for file

```python
        async with Vaas() as vaas:
            await vaas.connect_with_client_credentials(
                CLIENT_ID,
                CLIENT_SECRET,
                TOKEN_URL,
                VAAS_URL,
                SSL_VERIFICATION
                )
            path = "/path/to/file"
            verdict = await vaas.for_file(path)
```

## <a name="interested"></a>I'm interested in VaaS

You need credentials to use the service in your application. If you are interested in using VaaS, please [contact us](mailto:oem@gdata.de).
