owasp-nest-sdk 1.0.0

API for OWASP related entities

OwaspNestSdk Python SDK 1.0.0

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

Versions

• API version: 1.0.0
• SDK version: 1.0.0

About the API

API for OWASP related entities

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

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

Installation

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

pip install owasp_nest_sdk

Setting a Custom Timeout

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

from owasp_nest_sdk import OwaspNestSdk

sdk = OwaspNestSdk(timeout=10000)

Sample Usage

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

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

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.

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

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
git_hub
owasp

Models

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.

Below is a list of all available models:

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.