# Source: https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/9.9/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/10.5/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/10.6/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/10.7/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/10.8/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.2/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.3/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.5/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.4/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/2025.6/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/sonarscanner-for-python.md

# Source: https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/ci-based-analysis/sonarscanner-for-python.md

# SonarScanner for Python

<details>

<summary>SonarScanner for Python — 1.3.0.4086 | <a href="https://sonarsource.atlassian.net/jira/software/c/projects/SCANPY/issues">Issue Tracker</a></summary>

**1.3.0.4086** <sup><sub>**2025-12-02**<sub></sup>\ <sup>Shai-Hulud security release</sup>\
[Download](https://pypi.org/project/pysonar/1.3.0.4086)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixversion%20%3D%201.3.0)

***

**1.2.1.3951** <sup><sub>**2025-10-31**<sub></sup>\ <sup>Ensure compatibility with Python 3.14</sup>\
[Download](https://pypi.org/project/pysonar/1.2.1.3951)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixversion%20%3D%201.2.1)

***

**1.1.0.2035** <sup><sub>**2025-06-18**<sub></sup>\ <sup>Improve handling of arguments and environment variables. Fix the return code on failure</sup>\
[Download](https://pypi.org/project/pysonar/1.1.0.2035/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%201.1)

***

**1.0.2.1722** <sup><sub>**2025-05-28**<sub></sup>\ <sup>Fix incompatibility with tarfile.extractall</sup>\
[Download](https://pypi.org/project/pysonar/1.0.2.1722/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%201.0.2)

***

**1.0.1.1548** <sup><sub>**2025-04-02**<sub></sup>\ <sup>Add support for sonar.organization property</sup>\
[Download](https://pypi.org/project/pysonar/1.0.1.1548/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%201.0.1)

***

**1.0.0.1453** <sup><sub>**2025-04-01**<sub></sup>\ <sup>First production-ready release, includes support for automatic JRE provisioning</sup>\
[Download](https://pypi.org/project/pysonar/1.0.0.1453/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%201.0)

***

**0.3.0.2016** <sup><sub>**2025-06-17**<sub></sup>\ <sup>Deprecate pysonar-scanner in favor of pysonar</sup>\
[Download](https://pypi.org/project/pysonar-scanner/0.3.0.2016/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%200.3)

***

**0.2.0.520** <sup><sub>**2024-10-15**<sub></sup>\ <sup>Update embedded sonar-scanner-cli</sup>\
[Download](https://pypi.org/project/pysonar-scanner/0.2.0.520/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%200.2)

***

**0.1.0.340** <sup><sub>**2024-06-10**<sub></sup>\ <sup>First beta release on PyPI</sup>\
[Download](https://pypi.org/project/pysonar-scanner/0.1.0.340/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%200.1.0.340)

***

**0.1.0.285** <sup><sub>**2024-04-08**<sub></sup>\ <sup>First beta release on test.pypi.org</sup>\
[Download](https://test.pypi.org/project/pysonar/0.1.0.285/)\
\
[Release notes](https://sonarsource.atlassian.net/issues/?jql=project%20%3D%20%22Sonar%20Scanner%20Python%22%20AND%20fixVersion%20%3D%200.1.0.285)

</details>

pysonar is a wrapper around SonarScanner CLI, available on PyPI.

### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* Python 3.9 or later

### Installing the SonarScanner for Python <a href="#installing-the-sonarscanner-for-python" id="installing-the-sonarscanner-for-python"></a>

To install with pip, run the following command:

```bash
pip install pysonar
```

### Using the SonarScanner for Python <a href="#using-the-sonarscanner-for-python" id="using-the-sonarscanner-for-python"></a>

Once installed, you can configure the analysis and run the scanner from the command line. It assumes a running instance of SonarQube Server or a project configured on SonarQube Cloud.

We do not recommend running an antivirus scanner on the machine where a SonarQube Server analysis runs, it could result in unpredictable behavior.

#### Setting the analysis properties <a href="#setting-the-analysis-properties" id="setting-the-analysis-properties"></a>

For the analysis to run, you’ll need to define analysis properties. There are multiple ways of providing them, described below in descending order of priority:

* Through CLI arguments to the `pysonar` command
* Environment variables for individual properties (e.g. `SONAR_TOKEN`, `SONAR_VERBOSE`, `SONAR_HOST_URL`, …)
* Generic environment variable `SONAR_SCANNER_JSON_PARAMS`
* Under the `[tool.sonar]` key of the `pyproject.toml` file
* In a dedicated `sonar-project.properties` file
* Through common properties extracted from the `pyproject.toml`

**Using CLI arguments**

Analysis properties can be provided as CLI arguments to the `pysonar` command. They follow the same convention as when running the [sonarscanner-cli](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/ci-based-analysis/sonarscanner-cli "mention") directly. This means that analysis properties provided that way should be prepended with `-D`, for instance:

```bash
pysonar -Dsonar.token=myAuthenticationToken
```

You can use all the arguments allowed by the SonarScanner CLI.

Additionally, some common properties can be provided using a shorter alias, such as:

```bash
pysonar --token "MyToken"
```

See [CLI\_ARGS](https://github.com/SonarSource/sonar-scanner-python/blob/master/CLI_ARGS.md) for more details.

**With a pyproject.toml file**

Inside a `pyproject.toml`, Sonar analysis properties can be defined under the `tool.sonar` table.

```toml
[tool.sonar]

# must be unique in a given SonarQube Server/SonarQube Cloud instance

projectKey=my:project

# --- optional properties ---

# defaults to project key

#projectName=My project

# defaults to 'not provided'

#projectVersion=1.0



# Path is relative to the pyproject.toml file. Defaults to .

#sources=.



# Encoding of the source code. Default is default system encoding

#sourceEncoding=UTF-8
```

For a list of analysis parameters, see the [analysis-parameters](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/analysis-parameters "mention") page.

In the `pyproject.toml` file, the prefix `sonar.` for parameter keys should be omitted. For example, `sonar.scm.provider` in the documentation will become `scm.provider` in the `pyproject.toml` file.

Properties in `pyproject.toml` files are expected to be provided in camel case. However, kebab case is also accepted:

```toml
[tool.sonar]

project-key=My Project key # valid alias for projectKey
```

By default, the scanner will expect the `pyproject.toml` file to be present in the current directory. However, its path can be provided manually through the `toml-path` CLI argument as well as through the `sonar.projectBaseDir` argument. For instance:

```bash
pysonar --toml-path "path/to/pyproject.toml"
```

Or:

```bash
pysonar --sonar-project-base-dir "path/to/projectBaseDir"
```

Or:

```bash
pysonar -Dsonar.projectBaseDir="path/to/projectBaseDir"
```

**Using project properties extracted from the pyproject.toml file**

When a `pyproject.toml` file is available, the scanner can deduce analysis properties from the project configuration. This is currently supported only for projects using `poetry`.

**With a sonar-project.properties file**

The analysis can be configured with a `sonar-project.properties` file, exactly like when you analyze with the [sonarscanner-cli](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/ci-based-analysis/sonarscanner-cli "mention"):

```toml
# must be unique in a given SonarQube Server/SonarQube Cloud instance

sonar.projectKey=my:project

# --- optional properties ---

# defaults to project key

#sonar.projectName=My project

# defaults to 'not provided'

#sonar.projectVersion=1.0



# Path is relative to the sonar-project.properties file. Defaults to .

#sonar.sources=.



# Encoding of the source code. Default is default system encoding

#sonar.sourceEncoding=UTF-8
```

**Through environment variables**

It is also possible to configure the scanner through environment variables:

```properties
export SONAR_HOST_URL="https://sonarcloud.io"
pysonar
```

### Installing from testPyPI <a href="#installing-from-testpypi" id="installing-from-testpypi"></a>

To install the latest pre-released version of SonarScanner for Python. Execute the following command:

```bash
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysonar
```