owasp-nest-sdk 1.0.0
API for OWASP related entities
Requires Python: >=3.9

# OwaspNestSdk Python SDK 1.0.0<a id="owaspnestsdk-python-sdk-100"></a>

Welcome to the OwaspNestSdk SDK documentation. This guide will help you get started with integrating and using the OwaspNestSdk SDK in your project.

[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)

## Versions<a id="versions"></a>

- API version: `1.0.0`
- SDK version: `1.0.0`

## About the API<a id="about-the-api"></a>

API for OWASP related entities

## Table of Contents<a id="table-of-contents"></a>

- [Setup & Configuration](#setup--configuration)
  - [Supported Language Versions](#supported-language-versions)
  - [Installation](#installation)
- [Setting a Custom Timeout](#setting-a-custom-timeout)
- [Sample Usage](#sample-usage)
- [Services](#services)
- [Models](#models)

## Setup & Configuration<a id="setup--configuration"></a>

### Supported Language Versions<a id="supported-language-versions"></a>

This SDK is compatible with the following versions: `Python >= 3.7`

### Installation<a id="installation"></a>

To get started with the SDK, we recommend installing using `pip`:

```bash
pip install owasp_nest_sdk
```

## Setting a Custom Timeout<a id="setting-a-custom-timeout"></a>

You can set a custom timeout for the SDK's HTTP requests as follows:

```py
from owasp_nest_sdk import OwaspNestSdk

sdk = OwaspNestSdk(timeout=10000)
```

# Sample Usage<a id="sample-usage"></a>

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

```py
from owasp_nest_sdk import OwaspNestSdk
from owasp_nest_sdk.models import State, ListIssuesOrdering

sdk = OwaspNestSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.git_hub.list_issues(
    state="open",
    ordering="created_at",
    page=1,
    page_size=9
)

print(result)

```

# Async Usage<a id="async-usage"></a>

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

```py
import asyncio
from owasp_nest_sdk import OwaspNestSdkAsync
from owasp_nest_sdk.models import State, ListIssuesOrdering

sdk = OwaspNestSdkAsync(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)


async def main():
  result = await sdk.git_hub.list_issues(
    state="open",
    ordering="created_at",
    page=1,
    page_size=9
)
  print(result)

asyncio.run(main())
```

## Services<a id="services"></a>

The SDK provides various services to interact with the API.

<details> 
<summary>Below is a list of all available services:</summary>

| Name    |
| :------ |
| git_hub |
| owasp   |

</details>

## Models<a id="models"></a>

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

<details> 
<summary>Below is a list of all available models:</summary>

| Name                      | Description                    |
| :------------------------ | :----------------------------- |
| PagedIssueSchema          |                                |
| State                     |                                |
| ListIssuesOrdering        |                                |
| PagedLabelSchema          |                                |
| ListLabelsOrdering        |                                |
| PagedOrganizationSchema   |                                |
| ListOrganizationsOrdering |                                |
| PagedReleaseSchema        |                                |
| ListReleasesOrdering      |                                |
| PagedRepositorySchema     |                                |
| ListRepositoriesOrdering  |                                |
| PagedUserSchema           |                                |
| ListUsersOrdering         |                                |
| UserSchema                | Schema for User.               |
| PagedChapterSchema        |                                |
| ListChaptersOrdering      |                                |
| PagedCommitteeSchema      |                                |
| ListCommitteesOrdering    |                                |
| PagedEventSchema          |                                |
| ListEventsOrdering        |                                |
| PagedProjectSchema        |                                |
| ProjectLevel              | Enum for OWASP project levels. |
| ListProjectsOrdering      |                                |
| IssueSchema               | Schema for Issue.              |
| LabelSchema               | Schema for Label.              |
| OrganizationSchema        | Schema for Organization.       |
| ReleaseSchema             | Schema for Release.            |
| RepositorySchema          | Schema for Repository.         |
| ChapterSchema             | Schema for Chapter.            |
| CommitteeSchema           | Schema for Committee.          |
| EventSchema               | Schema for Event.              |
| ProjectSchema             | Schema for Project.            |

</details>

<!-- This file was generated by liblab | https://liblab.com/ -->