Qodana for Python

Qodana Python is based on PyCharm Professional and provides static analysis for Python projects.

Try it now

Analyze a project locally

Install project dependencies

For a basic Python project that has no external dependencies, no preliminary steps are required.

In case the project has external pip dependencies, you can set them up using the bootstrap field in the qodana.yaml file.
For example, if your project dependencies are specified by the requirements.txt file in your project root, add the following line to qodana.yaml:

bootstrap: pip install -r requirements.txt

The command will be automatically executed before the analysis.

Run analysis

Qodana provides two options for local analysis of your code. Qodana CLI is the easiest option to start. Alternatively, you can use the Docker command from the Docker image tab.

Assuming that you have already installed Qodana CLI on your machine, you can run this command in the project root directory:

qodana scan -l jetbrains/qodana-python:2022.3-eap --show-report

To start, pull the image from Docker Hub (only necessary to get the latest version):

docker pull jetbrains/qodana-python:2022.3-eap

Start local analysis with source-directory pointing to the root of your project:

                    docker run --rm -it \
                    -v <source-directory>/:/data/project/ \
                    -p 8080:8080 jetbrains/qodana-python:2022.3-eap --show-report
                

Open http://localhost:8080 in your browser to examine inspection results. Here, you can also reconfigure the analysis, see the User interface overview section for details. When done, you can stop the web server by pressing Ctrl-C in the console.

Next steps

Last modified: 21 October 2022