Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited README #24

Closed
wants to merge 2 commits into from
Closed

Edited README #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
751ace1
Edited README
0x41424142 Jul 24, 2024
86e1b3b
Updated README.md
0x41424142 Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
··············································
```

This package attempts to make it much easier to interact with Qualys's various API endpoints, across most modules.
This package attempts to make it much easier to interact with Qualys's various API endpoints, across as many modules as I can get to.

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ![development status](https://img.shields.io/badge/in%20development-8A2BE2) ![black formatter status](https://github.com/0x41424142/qualyspy/actions/workflows/black.yml/badge.svg?event=push)

Expand All @@ -30,18 +30,13 @@ assets = uber.get(
```
## Non-Uber Class Example
```py
from qualyspy.auth import TokenAuth
from qualyspy.gav import query_assets
from qualyspy.auth import BasicAuth
from qualyspy.vmdr import get_scan_list

auth = TokenAuth(<username>,'password', platform='qg1')
auth = BasicAuth(<username>,'password', platform='qg1')

linux_servers_with_1cpu = query_assets(
auth,
filter='operatingSystem.category1:`Linux` and operatingSystem.category2:`Server` and processors.numberOfCpu:1',
lastModifiedDate='2024-06-21'
)
>>> linux_servers_with_1core
[AssetID(<0123>), AssetID(<4567>), ...]
scans = get_scan_list(auth)
>>>[VMScan(REF='scan/123456789', TITLE='My Scan')]
```

## Current Supported Modules
Expand Down Expand Up @@ -484,6 +479,7 @@ This collection of APIs allows for the management of VM scans in VMDR, located u

### VMScan Dataclass
The ```VMScan``` dataclass is used to store the various fields that the VMDR VM Scan APIs return. Attributes are as follows:

|Attribute|Type|Description|
|--|--|--|
|```REF```|```str```|Reference string for the scan. Formatted as module/ID.|
Expand Down