SonarQube SDK

https://sonarqube-sdk.readthedocs.io/en/latest
Admin
A fully-typed Python SDK for the SonarQube API that enables developers to interact with SonarQube...
Tokens:27,605
Snippets:338
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install from source

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/installation.rst.txt

Clones the repository and installs the package in editable mode.

```bash
git clone https://github.com/silasvasconcelos/sonarqube-sdk.git
cd sonarqube-sdk
pip install -e .
```

--------------------------------

### Development installation

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/installation.rst.txt

Clones the repository and installs the package with development dependencies using make.

```bash
git clone https://github.com/silasvasconcelos/sonarqube-sdk.git
cd sonarqube-sdk
make dev
```

--------------------------------

### Install SonarQube SDK

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/index.rst.txt

Use these commands to install the SDK via pip or uv.

```bash
pip install sonarqube-sdk
```

```bash
uv add sonarqube-sdk
```

--------------------------------

### Install via uv

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/installation.rst.txt

Installation command using the uv package manager.

```bash
uv add sonarqube-sdk
```

--------------------------------

### Install via pip

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/installation.rst.txt

Standard installation command using the pip package manager.

```bash
pip install sonarqube-sdk
```

--------------------------------

### Retrieve Application Details

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Example usage for showing application details via the client.

```python
>>> response = client.applications.show(application="my-app")
>>> print(response.application.name)
```

--------------------------------

### Search Applications

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Example usage for searching applications via the client.

```python
>>> response = client.applications.search(q="my-app")
>>> for app in response.applications:
...     print(app.name)
```

--------------------------------

### Authenticate with SonarQubeClient

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Examples of different authentication methods including basic and custom handlers.

```python
client = SonarQubeClient(
    base_url="https://sonarqube.example.com", username="admin", password="admin"
)
```

```python
client = SonarQubeClient(
    base_url="https://sonarqube.example.com", token="squ_abcdef123456"
)
```

```python
client = SonarQubeClient(
    base_url="https://sonarqube.example.com", username="admin", password="admin"
)
```

```python
from sonarqube.auth import TokenAuth

auth = TokenAuth(token="my-token")
client = SonarQubeClient(base_url="https://sonarqube.example.com", auth=auth)
```

--------------------------------

### Bulk Activate Rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Example of performing a bulk activation of rules for a specific language.

```python
>>> result = client.qualityprofiles.activate_rules(
...     target_key="py-my-profile-12345", languages=["py"]
... )
```

--------------------------------

### Common Projects API Operations

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Basic usage examples for searching, creating, and deleting projects using the client instance.

```python
# Search for projects
projects = client.projects.search(q="backend")

# Create a project
project = client.projects.create(name="My Project", project="my-project")

# Delete a project
client.projects.delete(project="my-project")
```

--------------------------------

### Bulk Delete Projects

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Example of deleting multiple projects at once using the bulk_delete method.

```python
>>> client.projects.bulk_delete(projects=["project1", "project2"])
```

--------------------------------

### Activate a Rule with Severity

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Example of activating a rule while specifying the severity level.

```python
>>> client.qualityprofiles.activate_rule(
...     key="py-my-profile-12345", rule="python:S1234", severity="MAJOR"
... )
```

--------------------------------

### Get Projects Using a Quality Profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Lists projects associated with a quality profile. Requires 'Browse' permission on the profile.

```python
>>> projects = client.qualityprofiles.projects(key="py-my-profile-12345")
```

--------------------------------

### Get License Usage Statistics

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Retrieves license usage information. Requires 'Administer System' permission.

```python
>>> usage = client.projects.license_usage()
>>> print(f"Total lines of code: {usage.lines_of_code}")
```

--------------------------------

### Get Quality Profile Details

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Retrieves detailed information about a specific quality profile by its key.

```python
>>> profile = client.qualityprofiles.show(key="py-my-profile-12345")
```

--------------------------------

### changelog

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Get changelog for a quality profile. Requires 'Browse' permission on the quality profile.

```APIDOC
## GET /changelog

### Description
Get changelog for a quality profile.

### Method
GET

### Endpoint
/changelog

### Query Parameters
- **language** (string) - Optional - Language key.
- **p** (integer) - Optional - Page number.
- **ps** (integer) - Optional - Page size.
- **qualityProfile** (string) - Optional - Quality profile name.
- **since** (string) - Optional - Start date for changelog.
- **to** (string) - Optional - End date for changelog.
```

--------------------------------

### Get Quality Gate by Project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Retrieves the quality gate associated with a specific project. Requires 'Browse' permission on the project.

```python
>>> gate = client.qualitygates.get_by_project(project="my-project")
```

--------------------------------

### Initialize Application Models

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Demonstrates how to instantiate an Application and its corresponding creation response.

```python
from sonarqube.models.applications import Application, ApplicationCreateResponse

# Response from create endpoint
response = ApplicationCreateResponse(
    application=Application(
        key="my-app", name="My Application", visibility="private"
    )
)
```

--------------------------------

### Create a Project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/quickstart.html

Initialize a new project with a specified name, key, and visibility.

```python
project = client.projects.create(
    name="My Project",
    project="my-project",
    visibility="private"
)
```

--------------------------------

### Initialize Application

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Create an instance of a SonarQube application.

```python
>>> app = Application(key="my-app", name="My Application", visibility="private")
```

--------------------------------

### Access Measures API

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Retrieves an instance of the MeasuresAPI for getting metrics.

```python
>>> measures = client.measures.component(
...     component="my-project", metric_keys=["coverage", "bugs"]
... )
```

--------------------------------

### Initialize and use SonarQubeClient

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Demonstrates basic client initialization with token authentication, accessing API namespaces, and closing the connection.

```python
from sonarqube import SonarQubeClient

# Initialize with token authentication
client = SonarQubeClient(
    base_url="https://sonarqube.example.com", token="your-token"
)

# Access API namespaces
projects = client.projects.search(q="backend")
issues = client.issues.search(project_keys=["my-project"])

# Close when done
client.close()
```

--------------------------------

### Initialize SonarQube Client and Fetch Data

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/index.rst.txt

Demonstrates how to authenticate with the SonarQube API and perform basic project and issue searches.

```python
from sonarqube import SonarQubeClient

# Initialize client with token authentication
client = SonarQubeClient(
    base_url="https://sonarqube.example.com",
    token="your-token"
)

# Search for projects
projects = client.projects.search(q="backend")
for project in projects.components:
    print(f"Project: {project.name}")

# Get issues
issues = client.issues.search(
    project_keys=["my-project"],
    severities=["CRITICAL", "BLOCKER"]
)
```

--------------------------------

### Search and List Quality Profiles

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Demonstrates initializing the client and listing available quality profiles.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# List quality profiles
profiles = client.qualityprofiles.search()
for profile in profiles.profiles:
    print(f"{profile.name} ({profile.language})")
```

--------------------------------

### Initialize and Use Applications API

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Demonstrates how to initialize the SonarQube client and perform basic application management tasks.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# Create an application
app = client.applications.create(
    name="My Application", key="my-app", visibility="private"
)

# Add a project to the application
client.applications.add_project(application="my-app", project="my-project")
```

```python
# Create an application
app = client.applications.create(name="My Application", key="my-app")

# Add a project
client.applications.add_project(application="my-app", project="my-project")

# Get application details
details = client.applications.show(application="my-app")
print(details.application.name)
```

--------------------------------

### Get Quality Profile Inheritance

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Retrieves inheritance information for a specific quality profile.

```python
>>> inheritance = client.qualityprofiles.inheritance(
...     language="py", quality_profile="My Profile"
... )
```

--------------------------------

### Initialize ApplicationProject

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Create an instance of a project within an application.

```python
>>> project = ApplicationProject(key="my-project", name="My Project", enabled=True)
```

--------------------------------

### Initialize and Use Projects API

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Demonstrates how to initialize the SonarQube client and perform basic project search and creation operations.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# Search for projects
projects = client.projects.search(q="backend")
for project in projects.components:
    print(project.name)

# Create a project
project = client.projects.create(name="My Project", project="my-project")
```

--------------------------------

### Get application leak period

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Fetches the leak period configuration for a given application.

```python
>>> leak = client.applications.show_leak(application="my-app")
```

--------------------------------

### GET /tags

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/issues.html

Retrieves a list of issue tags, optionally filtered by project or search query.

```APIDOC
## GET /tags

### Description
Get list of issue tags. Requires 'Browse' permission on the project.

### Method
GET

### Endpoint
/tags

### Parameters
#### Query Parameters
- **project** (string) - Optional - Project key.
- **ps** (integer) - Optional - Page size (max 100).
- **q** (string) - Optional - Search query for tags.
```

--------------------------------

### Search and Iterate Issues

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/issues.html

Demonstrates initializing the client and searching for issues filtered by project and severity.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# Search for issues
issues = client.issues.search(
    project_keys=["my-project"], severities=["CRITICAL", "BLOCKER"]
)
for issue in issues.issues:
    print(f"{issue.severity}: {issue.message}")
```

--------------------------------

### Create New Application

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Creates a new application with specified name, key, and visibility settings.

```python
>>> app = client.applications.create(
...     name="My Application", key="my-app", visibility="private"
... )
>>> print(app.application.key)
'my-app'
```

--------------------------------

### Search for Rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Demonstrates initializing the client and searching for rules filtered by language.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# Search for rules
rules = client.rules.search(languages=["py"])
for rule in rules.rules:
    print(f"{rule.key}: {rule.name}")
```

--------------------------------

### SonarQubeClient.__init__

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Initializes a new instance of the SonarQubeClient to connect to a SonarQube instance.

```APIDOC
## SonarQubeClient(base_url, token=None, username=None, password=None, auth=None, timeout=DEFAULT_TIMEOUT, verify_ssl=True)

### Description
Initializes the SonarQube client with the necessary connection and authentication details.

### Parameters
- **base_url** (str) - Required - Base URL of the SonarQube instance.
- **token** (str) - Optional - API token for authentication.
- **username** (str) - Optional - Username for basic authentication.
- **password** (str) - Optional - Password for basic authentication.
- **auth** (BaseAuth) - Optional - Custom authentication handler.
- **timeout** (float) - Optional - Request timeout in seconds.
- **verify_ssl** (bool) - Optional - Whether to verify SSL certificates.

### Example
```python
from sonarqube import SonarQubeClient

# Initialize with token
client = SonarQubeClient(base_url="https://sonarqube.example.com", token="your-token")

# Initialize with basic auth
client = SonarQubeClient(base_url="https://sonarqube.example.com", username="admin", password="admin")
```
```

--------------------------------

### Create a SonarQube Project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Creates a new project with specified name, key, and visibility.

```python
>>> project = client.projects.create(
...     name="My Project", project="my-project", visibility="private"
... )
>>> print(project.project.key)
'my-project'
```

--------------------------------

### Get Project Quality Gate Status

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Checks the quality gate status for a project. Requires 'Browse' permission on the project.

```python
>>> status = client.qualitygates.project_status(project_key="my-project")
>>> if status.project_status.status == "OK":
...     print("Quality gate passed!")
```

--------------------------------

### create

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Creates a new application in SonarQube. Requires 'Administrator' permission on the portfolio parent if it exists.

```APIDOC
## create

### Description
Create a new application.

### Parameters
- **name** (str) - Required - Application name.
- **description** (str) - Optional - Application description.
- **key** (str) - Optional - Application key. If not provided, a key will be generated.
- **visibility** (str) - Optional - Application visibility (public/private).
```

--------------------------------

### Initialize ApplicationBranch

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Create an instance of an application branch.

```python
>>> branch = ApplicationBranch(name="main", isMain=True)
>>> print(branch.is_main)
True
```

--------------------------------

### project_status(analysis_id, branch, project_id, project_key, pull_request)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Get quality gate status for a project. Requires 'Browse' permission on the project.

```APIDOC
## project_status(analysis_id, branch, project_id, project_key, pull_request)

### Description
Get quality gate status for a project.

### Parameters
- **analysis_id** (str) - Optional - Analysis ID.
- **branch** (str) - Optional - Branch name.
- **project_id** (str) - Optional - Project ID.
- **project_key** (str) - Optional - Project key.
- **pull_request** (str) - Optional - Pull request ID.

### Example
```python
status = client.qualitygates.project_status(project_key="my-project")
if status.project_status.status == "OK":
    print("Quality gate passed!")
```
```

--------------------------------

### Initialize and Use Quality Gates API

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Demonstrates basic initialization of the SonarQube client and usage of quality gate listing and project status checks.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(base_url="...", token="...")

# List quality gates
gates = client.qualitygates.list()
for gate in gates.qualitygates:
    print(gate.name)

# Check project status
status = client.qualitygates.project_status(project_key="my-project")
print(f"Status: {status.project_status.status}")
```

```python
# List quality gates
gates = client.qualitygates.list()

# Check project status
status = client.qualitygates.project_status(project_key="my-project")
```

--------------------------------

### Initialize ProjectComponent

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/projects.html

Instantiate a ProjectComponent object to represent a project within the system.

```python
>>> component = ProjectComponent(
...     key="my-project", name="My Project", qualifier="TRK", visibility="private"
... )
```

--------------------------------

### create(name, project, ...)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Creates a new project in SonarQube.

```APIDOC
## POST /create

### Description
Creates a new project with the specified name and key.

### Parameters
- **name** (str) - Required - Project name
- **project** (str) - Required - Project key
- **mainBranch** (str) - Optional - Main branch name
- **newCodeDefinitionType** (str) - Optional - Type of new code definition
- **newCodeDefinitionValue** (str) - Optional - Value for new code definition
- **visibility** (str) - Optional - Project visibility (e.g., "private")
```

--------------------------------

### Initialize ApplicationCreateResponse

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Create an instance of the application creation response.

```python
>>> response = ApplicationCreateResponse(
...     application=Application(key="my-app", name="My App")
... )
```

--------------------------------

### ProjectsAPI.create()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/projects.html

Create a new project. Requires 'Create Projects' permission.

```APIDOC
## create(name, project, main_branch=None, new_code_definition_type=None, new_code_definition_value=None, visibility=None)

### Description
Create a new project. Requires 'Create Projects' permission.

### Parameters
- **name** (str) - Required - Project name (max 500 characters).
- **project** (str) - Required - Project key (unique identifier).
- **main_branch** (str) - Optional - Main branch name (defaults to 'main').
- **new_code_definition_type** (str) - Optional - Type for new code definition.
- **new_code_definition_value** (str) - Optional - Value for new code definition.
- **visibility** (str) - Optional - Project visibility (public/private).

### Response
- **ProjectCreateResponse** (object) - Response containing the created project.
```

--------------------------------

### create

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Creates a new quality profile. Requires 'Administer Quality Profiles' permission.

```APIDOC
## POST /create

### Description
Creates a new quality profile. Requires 'Administer Quality Profiles' permission.

### Method
POST

### Endpoint
/create

### Request Body
- **language** (string) - Required - Language key.
- **name** (string) - Required - Quality profile name.
```

--------------------------------

### Initialize QualityGate Model

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/qualitygates.html

Create a local instance of a QualityGate object.

```python
gate = QualityGate(id="1", name="My Quality Gate", isDefault=True)
```

--------------------------------

### Instantiating a Rule Model

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/rules.html

Shows the manual instantiation of a Rule object with basic attributes.

```python
>>> rule = Rule(
...     key="python:S1234",
...     repo="python",
...     name="Unused variables should be removed",
...     severity="MAJOR",
... )
```

--------------------------------

### QualityGatesAPI.list()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Lists all available quality gates.

```APIDOC
### Method
`client.qualitygates.list()`

### Returns
- `QualityGateListResponse` - Response containing the list of quality gates.
```

--------------------------------

### Create a Quality Profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Creates a new quality profile for a specific language. Requires 'Administer Quality Profiles' permission.

```python
>>> profile = client.qualityprofiles.create(language="py", name="My Custom Profile")
```

--------------------------------

### Handle Project Creation Response

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/projects.html

Access the project details returned after a successful project creation request.

```python
>>> response = client.projects.create(name="My Project", project="my-project")
>>> print(response.project.key)
```

--------------------------------

### ProjectsAPI.create

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Creates a new project in SonarQube. Requires 'Create Projects' permission.

```APIDOC
## create(name, project, main_branch=None, new_code_definition_type=None, new_code_definition_value=None, visibility=None)

### Description
Create a new project.

### Parameters
- **name** (str) - Required - Project name (max 500 characters).
- **project** (str) - Required - Project key (unique identifier).
- **main_branch** (str) - Optional - Main branch name (defaults to 'main').
- **new_code_definition_type** (str) - Optional - Type for new code definition.
- **new_code_definition_value** (str) - Optional - Value for new code definition.
- **visibility** (str) - Optional - Project visibility (public/private).

### Returns
- **ProjectCreateResponse** - Response containing the created project.
```

--------------------------------

### Using Rule Search Models

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/rules.html

Demonstrates how to use the RuleSearchResponse model to iterate through rules returned by the client search API.

```python
from sonarqube.models.rules import RuleSearchResponse

response = client.rules.search(languages=["py"])
for rule in response.rules:
    print(f"{rule.key}: {rule.name}")
```

--------------------------------

### Instantiate QualityProfile Model

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/qualityprofiles.html

Create a new QualityProfile instance with required fields.

```python
>>> profile = QualityProfile(
...     key="py-my-profile-12345",
...     name="My Python Profile",
...     language="py",
...     languageName="Python",
... )
```

--------------------------------

### Manage Projects

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Search for existing projects or create new ones using the client projects interface.

```python
# Search all projects
projects = client.projects.search()

# Search with filter
projects = client.projects.search(q="backend")

# Iterate over results
for project in projects.components:
    print(f"Project: {project.name} ({project.key})")
```

```python
project = client.projects.create(
    name="My Project",
    project="my-project",
    visibility="private"
)
```

--------------------------------

### show(application, branch=None)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/applications.html

Retrieves details for a specific application. Requires Browse permission.

```APIDOC
## show(application, branch=None)

### Description
Get application details. Requires ‘Browse’ permission on the application.

### Parameters
- **application** (str) - Required - Application key.
- **branch** (str) - Optional - Branch name.

### Example
```python
response = client.applications.show(application="my-app")
```
```

--------------------------------

### Search and Activate Rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Shows how to search for profiles by language and activate a specific rule.

```python
# Search quality profiles
profiles = client.qualityprofiles.search(language="py")

# Activate a rule
client.qualityprofiles.activate_rule(
    key="py-my-profile-12345", rule="python:S1234"
)
```

--------------------------------

### select(gate_name, project_key)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Associate a project with a quality gate. Requires 'Administer' permission on the project.

```APIDOC
## select(gate_name, project_key)

### Description
Associate a project with a quality gate.

### Parameters
- **gate_name** (str) - Required - Quality gate name.
- **project_key** (str) - Optional - Project key.

### Example
```python
client.qualitygates.select(gate_name="Sonar way", project_key="my-project")
```
```

--------------------------------

### Backup a quality profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Requires 'Administer Quality Profiles' permission. Returns the XML backup content.

```python
>>> backup = client.qualityprofiles.backup(
...     language="py", quality_profile="My Profile"
... )
```

--------------------------------

### Instantiate an Issue model

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/issues.html

Shows how to manually create an Issue object with required fields.

```python
>>> issue = Issue(
...     key="AXoN-12345",
...     rule="python:S1234",
...     severity="MAJOR",
...     component="my-project:src/main.py",
...     project="my-project",
...     message="Remove this unused variable",
... )
```

--------------------------------

### create

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Creates a new custom rule. Requires 'Administer Quality Profiles' permission.

```APIDOC
## create(custom_key, markdown_description, name, template_key, ...)

### Description
Creates a custom rule based on an existing template.

### Parameters
- **custom_key** (str) - Required - Key for the custom rule.
- **markdown_description** (str) - Required - Rule description in markdown.
- **name** (str) - Required - Rule name.
- **template_key** (str) - Required - Template rule key.
- **clean_code_attribute** (str) - Optional - Clean code attribute.
- **impacts** (str) - Optional - Impacts specification.
- **params** (str) - Optional - Rule parameters.
- **prevent_reactivation** (bool) - Optional - Prevent reactivation of a removed rule.
- **severity** (str) - Optional - Rule severity.
- **status** (str) - Optional - Rule status.
- **type_** (str) - Optional - Rule type.
```

--------------------------------

### client.qualitygates.list

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Lists all available quality gates.

```APIDOC
## GET /list

### Description
List all quality gates.

### Method
GET

### Endpoint
/list
```

--------------------------------

### add_project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Adds a project to an existing application. Requires 'Administrator' permission on the application and 'Browse' permission on the project.

```APIDOC
## add_project

### Description
Adds a project to an application.

### Parameters
- **application** (str) - Required - Application key.
- **project** (str) - Required - Project key.
```

--------------------------------

### backup

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Backup a quality profile as XML. Requires 'Administer Quality Profiles' permission.

```APIDOC
## GET /backup

### Description
Backup a quality profile as XML.

### Method
GET

### Endpoint
/backup

### Query Parameters
- **language** (string) - Required - Language key.
- **qualityProfile** (string) - Required - Quality profile name.
```

--------------------------------

### show

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Retrieves details for a specific application.

```APIDOC
## show

### Description
Get application details. Requires 'Browse' permission on the application.

### Parameters
- **application** (str) - Required - Application key.
- **branch** (str) - Optional - Branch name.
```

--------------------------------

### client.qualitygates.list()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Retrieves a list of all quality gates configured in the SonarQube instance.

```APIDOC
## client.qualitygates.list()

### Description
Fetches the collection of quality gates available in the system. Returns a QualityGateListResponse object containing the list of gates and the default gate ID.

### Response
- **qualitygates** (list[QualityGate]) - List of quality gate objects.
- **default** (str) - ID of the default quality gate.
- **actions** (dict) - Available actions for the user.
```

--------------------------------

### add_project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Associate a project with a quality profile. Requires 'Administer' permission on the project.

```APIDOC
## POST /add_project

### Description
Associate a project with a quality profile.

### Method
POST

### Endpoint
/add_project

### Request Body
- **key** (string) - Required - Quality profile key.
- **project** (string) - Required - Project key.
```

--------------------------------

### create(name: str)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Creates a new quality gate. Requires 'Administer Quality Gates' permission.

```APIDOC
## create(name)

### Description
Creates a new quality gate. Requires 'Administer Quality Gates' permission.

### Parameters
- **name** (str) - Required - Quality gate name.

### Returns
- **QualityGateCreateResponse** - Response containing the created quality gate.
```

--------------------------------

### Associate a project with a quality profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Requires 'Administer' permission on the project.

```python
>>> client.qualityprofiles.add_project(
...     key="py-my-profile-12345", project="my-project"
... )
```

--------------------------------

### SonarQubeClient Methods

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/client.html

Methods for managing the lifecycle of the SonarQube client instance.

```APIDOC
## close()

### Description
Close the client and release resources.

## __enter__()

### Description
Enter context manager.

## __exit__(exc_type, exc_val, exc_tb)

### Description
Exit context manager and close client.
```

--------------------------------

### do_transition

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/issues.html

Performs a transition on an issue.

```APIDOC
## do_transition(issue, transition)

### Description
Perform a transition on an issue. Requires authentication and 'Browse' permission on the project.

### Parameters
- **issue** (str) - Required - Issue key.
- **transition** (str) - Required - Transition to perform (confirm, unconfirm, reopen, resolve, falsepositive, wontfix, close).

### Response
- **Issue** (object) - The updated issue.
```

--------------------------------

### show(key, compare_to_sonar_way)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Retrieves detailed information about a specific quality profile.

```APIDOC
## show(key, compare_to_sonar_way)

### Description
Get quality profile details.

### Parameters
- **key** (str) - Optional - Quality profile key.
- **compare_to_sonar_way** (bool) - Optional - Compare to Sonar way.
```

--------------------------------

### Perform common SonarQube API operations

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Shows how to search for projects and retrieve issues with specific severities.

```python
from sonarqube import SonarQubeClient

client = SonarQubeClient(
    base_url="https://sonarqube.example.com", token="your-token"
)

# Search for projects
projects = client.projects.search(q="backend")
for project in projects.components:
    print(project.name)

# Get issues for a project
issues = client.issues.search(
    project_keys=["my-project"], severities=["CRITICAL", "BLOCKER"]
)
for issue in issues.issues:
    print(f"{issue.severity}: {issue.message}")

client.close()
```

--------------------------------

### list()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Retrieves a list of all quality gates.

```APIDOC
## list()

### Description
Returns a response containing a list of quality gates.

### Parameters
None

### Example
```python
response = client.qualitygates.list()
for gate in response.qualitygates:
    print(gate.name)
```
```

--------------------------------

### repositories

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Lists rule repositories available in the SonarQube instance.

```APIDOC
## repositories(language=None, q=None)

### Description
Retrieves a list of rule repositories, optionally filtered by language or search query.

### Parameters
- **language** (str) - Optional - Filter by language.
- **q** (str) - Optional - Search query for repository name.
```

--------------------------------

### Retrieve Settings

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Use the settings API to retrieve specific configuration values.

```python
>>> settings = client.settings.values(keys=["sonar.core.serverBaseURL"])
```

--------------------------------

### Perform an issue transition

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/issues.html

Executes a state transition on an issue, such as resolving or reopening it. Requires 'Browse' permission.

```python
>>> issue = client.issues.do_transition(issue="AXoN-12345", transition="resolve")
```

--------------------------------

### RulesAPI.repositories()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/rules.html

Lists rule repositories, optionally filtered by language or search query.

```APIDOC
## RulesAPI.repositories()

### Description
Retrieves a list of rule repositories.

### Parameters
- **language** (str) - Optional - Filter by language.
- **q** (str) - Optional - Search query for repository name.

### Response
- **RuleRepositoriesResponse** (Object) - Response containing list of repositories.
```

--------------------------------

### Search for issues using IssueSearchResponse

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/issues.html

Demonstrates how to use the IssueSearchResponse model to iterate through issues returned by the search endpoint.

```python
from sonarqube.models.issues import IssueSearchResponse

response = client.issues.search(project_keys=["my-project"])
for issue in response.issues:
    print(f"{issue.severity}: {issue.message}")
```

--------------------------------

### Search for SonarQube rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/rules.html

Demonstrates how to search for rules by language and iterate through the returned RuleSearchResponse object.

```python
>>> response = client.rules.search(languages=["py"])
>>> print(f"Found {response.total} rules")
>>> for rule in response.rules:
...     print(rule.name)
```

--------------------------------

### List Application Branches

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Retrieve and iterate through branches for a given application.

```python
>>> response = client.applications.list_branches(application="my-app")
>>> for branch in response.branches:
...     print(branch.name)
```

--------------------------------

### client.qualityprofiles.projects

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualityprofiles.html

Lists projects associated with a quality profile. Requires 'Browse' permission.

```APIDOC
## client.qualityprofiles.projects

### Description
Get projects using a quality profile. Requires ‘Browse’ permission on the quality profile.

### Parameters
- **key** (str) - Required - Quality profile key.
- **p** (int) - Optional - Page number.
- **ps** (int) - Optional - Page size.
- **q** (str) - Optional - Search query for project name.
- **selected** (str) - Optional - Filter selection (all, selected, deselected).

### Example
```python
projects = client.qualityprofiles.projects(key="py-my-profile-12345")
```
```

--------------------------------

### Add Project to Application

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Adds a project to an existing application. Requires Administrator permission on the application and Browse permission on the project.

```python
>>> client.applications.add_project(application="my-app", project="my-project")
```

--------------------------------

### Search Projects

Source: https://sonarqube-sdk.readthedocs.io/en/latest/quickstart.html

Retrieve projects using search filters and iterate through the results.

```python
# Search all projects
projects = client.projects.search()

# Search with filter
projects = client.projects.search(q="backend")

# Iterate over results
for project in projects.components:
    print(f"Project: {project.name} ({project.key})")
```

--------------------------------

### Search for Rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Demonstrates how to search for rules filtered by language and iterate through the returned results.

```python
>>> response = client.rules.search(languages=["py"])
>>> for rule in response.rules:
...     print(f"{rule.key}: {rule.name}")
```

--------------------------------

### List Rule Repositories

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Retrieves a list of rule repositories, optionally filtered by language or search query.

```python
>>> repos = client.rules.repositories(language="py")
>>> for repo in repos.repositories:
...     print(repo)
```

--------------------------------

### Create a Quality Gate

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Creates a new quality gate with the specified name. Requires 'Administer Quality Gates' permission.

```python
>>> gate = client.qualitygates.create(name="My Quality Gate")
>>> print(gate.id)
```

--------------------------------

### search(additional_fields=None, asc=None, assigned=None, assignees=None, author=None, branch=None, clean_code_attribute_categories=None, code_variants=None, component_keys=None, created_after=None, created_at=None, created_before=None, created_in_last=None, directories=None, facets=None, files=None, impact_severities=None, impact_software_qualities=None, in_new_code_period=None, issue_statuses=None, issues=None, languages=None, on_component_only=None, p=None, project_keys=None, ps=None, pull_request=None, resolutions=None, resolved=None, rules=None, s=None, scopes=None, severities=None, statuses=None, tags=None, types=None)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/issues.html

Searches for issues based on various criteria such as project keys, severities, and creation dates. Returns an IssueSearchResponse containing a list of issues and paging information.

```APIDOC
## search

### Description
Searches for issues based on various criteria such as project keys, severities, and creation dates. Returns an IssueSearchResponse containing a list of issues and paging information.

### Parameters
- **project_keys** (list[str]) - Optional - Project keys.
- **severities** (list[str]) - Optional - Filter by severities.
- **p** (int) - Optional - Page number.
- **ps** (int) - Optional - Page size.

### Example
```python
response = client.issues.search(project_keys=["my-project"], severities=["CRITICAL", "BLOCKER"])
for issue in response.issues:
    print(f"{issue.severity}: {issue.message}")
```
```

--------------------------------

### Search and Show Rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Basic usage for searching rules and retrieving specific rule details by key.

```python
# Search for Python rules
rules = client.rules.search(languages=["py"])

# Get rule details
rule = client.rules.show(key="python:S1234")
```

--------------------------------

### List All Quality Gates

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Retrieves a list of all available quality gates.

```python
>>> response = client.qualitygates.list()
>>> for gate in response.qualitygates:
...     print(gate.name)
```

--------------------------------

### Create a Custom Rule

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Creates a new custom rule based on an existing template. Requires 'Administer Quality Profiles' permission.

```python
>>> rule = client.rules.create(
...     custom_key="my-rule",
...     markdown_description="Description",
...     name="My Custom Rule",
...     template_key="python:S100",
... )
```

--------------------------------

### Set Default Quality Profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Sets a specific quality profile as the default for a given language. Requires 'Administer Quality Profiles' permission.

```python
>>> client.qualityprofiles.set_default(language="py", quality_profile="My Profile")
```

--------------------------------

### Process Project Search Response

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/projects.html

Access paging information and project components from a search response.

```python
>>> response = client.projects.search(q="backend")
>>> print(f"Found {response.paging.total} projects")
>>> for project in response.components:
...     print(project.name)
```

--------------------------------

### Copy a Quality Profile

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Copies an existing quality profile to a new one. Requires 'Administer Quality Profiles' permission.

```python
>>> profile = client.qualityprofiles.copy(
...     from_key="py-sonar-way-12345", to_name="My Custom Profile"
... )
```

--------------------------------

### set_as_default(name)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/qualitygates.html

Set a quality gate as the default. Requires 'Administer Quality Gates' permission.

```APIDOC
## set_as_default(name)

### Description
Set a quality gate as the default.

### Parameters
- **name** (str) - Required - Quality gate name.

### Example
```python
client.qualitygates.set_as_default(name="My Quality Gate")
```
```

--------------------------------

### Handle Issues

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Search for specific issues by severity or transition an issue state.

```python
# Get all critical issues
issues = client.issues.search(
    project_keys=["my-project"],
    severities=["CRITICAL", "BLOCKER"]
)

for issue in issues.issues:
    print(f"Issue: {issue.message}")
```

```python
# Mark issue as resolved
client.issues.do_transition(
    issue="AXoN-12345",
    transition="resolve"
)
```

--------------------------------

### show(name: Optional[str] = None)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Retrieves the details of a specific quality gate by its name.

```APIDOC
## show(name: Optional[str] = None)

### Description
Get quality gate details.

### Parameters
- **name** (str) - Optional - Quality gate name.

### Example
```python
gate = client.qualitygates.show(name="Sonar way")
print(gate.name)
```
```

--------------------------------

### Retrieve Source Lines

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/client.html

Use the sources API to fetch lines of code for a specific file key.

```python
>>> sources = client.sources.lines(key="my-project:src/main.py")
```

--------------------------------

### activate_rules

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Bulk activates rules in a quality profile based on various filter criteria. Requires 'Administer Quality Profiles' permission.

```APIDOC
## activate_rules

### Description
Bulk activates rules in a quality profile.

### Parameters
- **target_key** (str) - Required - Target quality profile key.
- **active_severities** (list[str]) - Optional - Filter by active severities.
- **asc** (bool) - Optional - Ascending sort order.
- **available_since** (str) - Optional - Filter by availability date.
- **inheritance** (list[str]) - Optional - Filter by inheritance.
- **is_template** (bool) - Optional - Filter template rules.
- **languages** (list[str]) - Optional - Filter by languages.
- **q** (str) - Optional - Search query.
- **qprofile** (str) - Optional - Source quality profile key.
- **repositories** (list[str]) - Optional - Filter by repositories.
- **rule_key** (str) - Optional - Filter by rule key.
- **s** (str) - Optional - Sort field.
- **severities** (list[str]) - Optional - Filter by severities.
- **statuses** (list[str]) - Optional - Filter by statuses.
- **tags** (list[str]) - Optional - Filter by tags.
- **target_severity** (str) - Optional - Severity to set on activated rules.
- **template_key** (str) - Optional - Filter by template key.
- **types** (list[str]) - Optional - Filter by types.
```

--------------------------------

### client.issues.tags

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/issues.html

Retrieves a list of tags for a given project.

```APIDOC
## client.issues.tags

### Description
Retrieves a list of tags associated with a project.

### Parameters
- **project** (str) - Optional - Project key.
- **ps** (int) - Optional - Page size (max 100).
- **q** (str) - Optional - Search query for tags.

### Example
```python
response = client.issues.tags(project="my-project")
for tag in response.tags:
    print(tag)
```
```

--------------------------------

### Retrieve Issue Tags

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/issues.html

Fetches a list of tags for a project, requiring 'Browse' permission.

```python
>>> response = client.issues.tags(project="my-project")
>>> for tag in response.tags:
...     print(tag)
```

--------------------------------

### copy(source_name: str, name: str)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Copies an existing quality gate to a new one. Requires 'Administer Quality Gates' permission.

```APIDOC
## copy(source_name, name)

### Description
Copies an existing quality gate to a new one. Requires 'Administer Quality Gates' permission.

### Parameters
- **source_name** (str) - Required - Source quality gate name.
- **name** (str) - Required - Name for the new quality gate.

### Returns
- **QualityGateCreateResponse** - Response containing the new quality gate.
```

--------------------------------

### tags(ps, q)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Lists the available rule tags, with optional pagination and search query.

```APIDOC
## tags(ps, q)

### Description
List rule tags.

### Parameters
- **ps** (int) - Optional - Page size.
- **q** (str) - Optional - Search query for tags.

### Example
```python
response = client.rules.tags()
for tag in response.tags:
    print(tag)
```
```

--------------------------------

### Search for Projects

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Searches for projects based on query parameters. Requires 'Browse' permission on returned projects.

```python
>>> response = client.projects.search(q="backend")
>>> for project in response.components:
...     print(project.name)
```

--------------------------------

### client.rules.show

Source: https://sonarqube-sdk.readthedocs.io/en/latest/api/rules.html

Retrieves the full details of a specific rule using its unique key.

```APIDOC
## client.rules.show(key, actives=None)

### Description
Get detailed information about a specific rule.

### Parameters
- **key** (str) - Required - Rule key.
- **actives** (bool) - Optional - Include active instances in quality profiles.

### Response
- **RuleShowResponse** - Response containing rule details.
```

--------------------------------

### Search Projects with Pydantic Models

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/projects.html

Use the ProjectSearchResponse model to handle results from project search queries.

```python
from sonarqube.models.projects import ProjectSearchResponse

response = client.projects.search(q="backend")
for project in response.components:
    print(project.name)
```

--------------------------------

### Handle SDK Exceptions

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_sources/quickstart.rst.txt

Catch specific SDK exceptions to manage authentication, permission, or resource errors.

```python
from sonarqube import SonarQubeClient
from sonarqube.exceptions import (
    SonarQubeAuthenticationError,
    SonarQubeNotFoundError,
    SonarQubePermissionError,
)

client = SonarQubeClient(base_url="...", token="...")

try:
    project = client.projects.search(q="test")
except SonarQubeAuthenticationError:
    print("Invalid credentials")
except SonarQubeNotFoundError:
    print("Resource not found")
except SonarQubePermissionError:
    print("Permission denied")
```

--------------------------------

### license_usage()

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/projects.html

Retrieves license usage statistics.

```APIDOC
## GET /license_usage

### Description
Returns license usage information. Requires 'Administer System' permission.
```

--------------------------------

### Create Application Branch Request

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/applications.html

Initialize a request object to create a new branch for an application.

```python
>>> request = CreateBranchRequest(
...     application="my-app", branch="feature-x", project=["project1", "project2"]
... )
```

--------------------------------

### Retrieve quality profile changelog

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Requires 'Browse' permission on the quality profile.

```python
>>> changelog = client.qualityprofiles.changelog(
...     language="py", quality_profile="My Profile"
... )
```

--------------------------------

### client.qualitygates.search

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Searches for projects associated with a specific quality gate. Requires 'Administer Quality Gates' permission.

```APIDOC
## GET /search

### Description
Search projects associated with a quality gate.

### Method
GET

### Endpoint
/search

### Parameters
#### Query Parameters
- **gateName** (string) - Required - Quality gate name.
- **page** (integer) - Optional - Page number.
- **pageSize** (integer) - Optional - Page size.
- **query** (string) - Optional - Search query.
- **selected** (string) - Optional - Filter selection (all, selected, deselected).
```

--------------------------------

### show(key, actives)

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Retrieves the details of a specific rule by its key.

```APIDOC
## show(key, actives)

### Description
Get rule details.

### Parameters
- **key** (str) - Required - Rule key.
- **actives** (bool) - Optional - Include active instances in quality profiles.

### Example
```python
response = client.rules.show(key="python:S1234")
print(response.rule.name)
```
```

--------------------------------

### Search for Quality Profiles

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Search for quality profiles using optional filters like language or project.

```python
>>> response = client.qualityprofiles.search(language="py")
>>> for profile in response.profiles:
...     print(f"{profile.name} ({profile.language})")
```

--------------------------------

### client.qualitygates.get_by_project

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Retrieves the quality gate associated with a specific project. Requires 'Browse' permission on the project.

```APIDOC
## GET /get_by_project

### Description
Get the quality gate for a project.

### Method
GET

### Endpoint
/get_by_project

### Parameters
#### Query Parameters
- **project** (string) - Required - Project key.
```

--------------------------------

### Retrieve Rule Details

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/rules.html

Fetches detailed information for a specific rule using its key.

```python
>>> response = client.rules.show(key="python:S1234")
>>> print(response.rule.name)
```

--------------------------------

### Copy a Quality Gate

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualitygates.html

Creates a new quality gate by copying an existing one. Requires 'Administer Quality Gates' permission.

```python
>>> gate = client.qualitygates.copy(source_name="Sonar way", name="My Quality Gate")
```

--------------------------------

### Create an application branch

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/applications.html

Creates a new branch for a specified application with associated projects.

```python
>>> client.applications.create_branch(
...     application="my-app",
...     branch="feature-x",
...     project=["project1", "project2"],
...     project_branch=["feature-x", "feature-x"],
... )
```

--------------------------------

### Search Issues

Source: https://sonarqube-sdk.readthedocs.io/en/latest/quickstart.html

Filter issues by project keys and severity levels.

```python
# Get all critical issues
issues = client.issues.search(
    project_keys=["my-project"],
    severities=["CRITICAL", "BLOCKER"]
)

for issue in issues.issues:
    print(f"Issue: {issue.message}")
```

--------------------------------

### copy

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/api/qualityprofiles.html

Copies an existing quality profile to a new one. Requires 'Administer Quality Profiles' permission.

```APIDOC
## POST /copy

### Description
Copies an existing quality profile to a new one. Requires 'Administer Quality Profiles' permission.

### Method
POST

### Endpoint
/copy

### Request Body
- **fromKey** (string) - Required - Source quality profile key.
- **toName** (string) - Required - Name for the new profile.
```

--------------------------------

### Define SearchProjectsResponse Model

Source: https://sonarqube-sdk.readthedocs.io/en/latest/_modules/sonarqube/models/qualitygates.html

Represents the response structure for searching projects associated with a quality gate.

```python
class SearchProjectsResponse(SonarQubeModel):
    """Response from searching projects with quality gate.

    Attributes:
        paging: Paging information.
        results: List of projects.
    """

    paging: Optional[dict[str, Any]] = Field(default=None, description="Paging")
    results: list[dict[str, Any]] = Field(default_factory=list, description="Results")
```
Tokens:
Raw