Metadata-Version: 2.4
Name: apimatic-semgrep-sdk
Version: 0.0.2
Summary: This is a sample API generated by APIMatic
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://apimatic.io
Keywords: Apimatic,sdksio
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
Requires-Dist: python-dotenv<2.0,>=0.21
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with Semgrep Web App

## Introduction

Welcome to Semgrep's portal for the Semgrep AppSec Platform web API.

### Introduction

Semgrep is a fast, open-source, static analysis tool for finding bugs and enforcing code standards at editor,
commit, and CI time. [Get started.](https://semgrep.dev/docs/getting-started/)

This API is documented in the **OpenAPI format**.

### Authentication

The API supports authentication with an API token with the "Web API" permission, without limited
scopes of access.

You can provision an API token [from the Settings page](https://semgrep.dev/orgs/-/settings/tokens).

### Terms of Use

Please note, the materials made available herein are subject to the
[Semgrep Terms of Use](https://semgrep.dev/resources/website-terms/), and your
access or use of any of the same is your acknowledgment and acceptance of the
such terms.

<br>


___


## Install the Package

The package is compatible with Python versions `3.7+`.
Install the package from PyPi using the following pip command:

```bash
pip install apimatic-semgrep-sdk==0.0.2
```

You can also view the package at:
https://pypi.python.org/pypi/apimatic-semgrep-sdk/0.0.2

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | `float` | The value to use for connection timeout. <br> **Default: 30** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| semgrep_admin_jwt_credentials | [`SemgrepAdminJwtCredentials`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
| semgrep_jwt_credentials | [`SemgrepJwtCredentials`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token-1.md) | The credential object for OAuth 2 Bearer token |
| semgrep_web_token_credentials | [`SemgrepWebTokenCredentials`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token-2.md) | The credential object for OAuth 2 Bearer token |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from semgrepwebapp.configuration import Environment
from semgrepwebapp.http.auth.semgrep_admin_jwt import SemgrepAdminJwtCredentials
from semgrepwebapp.http.auth.semgrep_jwt import SemgrepJwtCredentials
from semgrepwebapp.http.auth.semgrep_web_token import SemgrepWebTokenCredentials
from semgrepwebapp.logging.configuration.api_logging_configuration import LoggingConfiguration
from semgrepwebapp.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from semgrepwebapp.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from semgrepwebapp.semgrepwebapp_client import SemgrepwebappClient

client = SemgrepwebappClient(
    semgrep_admin_jwt_credentials=SemgrepAdminJwtCredentials(
        access_token='AccessToken'
    ),
    semgrep_jwt_credentials=SemgrepJwtCredentials(
        access_token='AccessToken'
    ),
    semgrep_web_token_credentials=SemgrepWebTokenCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)
```

### Environment-Based Client Initialization

```python
from semgrepwebapp.semgrepwebapp_client import SemgrepwebappClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SemgrepwebappClient.from_environment(dotenv_path='/path/to/.env')
```

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/environment-based-client-initialization.md) section for details.

## Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

| Name | Description |
|  --- | --- |
| PRODUCTION | **Default** |

## Authorization

This API uses the following authentication schemes.

* [`SemgrepAdminJWT (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md)
* [`SemgrepJWT (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token-1.md)
* [`SemgrepWebToken (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token-2.md)

## List of APIs

* [Deployments Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/deployments-service.md)
* [Findings Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/findings-service.md)
* [Misc Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/misc-service.md)
* [Policies Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/policies-service.md)
* [Projects Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/projects-service.md)
* [Scans Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/scans-service.md)
* [Secrets Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/secrets-service.md)
* [Supply Chain Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/supply-chain-service.md)
* [Ticketing Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/ticketing-service.md)
* [Triage Service](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/controllers/triage-service.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/apimatic-semgrep-python-sdk/tree/0.0.2/doc/unix-date-time.md)

