Aqua 2024.3 Help

Manage dependencies using requirements.txt

Aqua provides integration with the major means of requirements management and makes it possible to track the unsatisfied requirements in your projects .

Define requirements

  1. From the Tools menu, select Sync Python Requirements.

  2. In the opened dialog, specify the name of the requirements file. The recommended name for the requirements file is requirements.txt. When a file with this name is added to the root project directory, it is automatically detected by Python Integrated tools.

    Define requirements.txt

  3. Select the method of handling versions of the required libraries. The version numbers can be defined:

    Method

    Example

    Strong equality

    Django==3.0.3

    Greater or equal

    Django>=3.0.3

    Compatible version

    Django~=3.0.3

  4. Define the requirements management policy:

    Policy

    Action

    Remove unused requirements

    Deletes records that correspond to unused libraries and packages.

    Modify base files

    Allows modifications in the base requirements files (if any is referenced in the requirements.txt file).

    Keep existing version specifier if it matches the current version

    Leaves the version number unchanged if it satisfied the selected method versions handling.

  5. Click OK and inspect the generated file.

    Generate requirements.txt file

You can also run pip freeze > requirements.txt in the command line to generate a requirements.txt file for your project. See https://pip.pypa.io/en/stable/reference/pip_freeze/ for more details.

If the name of the requirements file differs from requirements.txt or when you have several requirements files in one project, you have to notify Aqua about the requirements file you want to apply.

Configure the default requirements file

  1. Press Ctrl+Alt+S to open settings and then select Tools | Python Integrated Tools.

  2. In the Package requirements file field, type the name of the requirements file or click the browse button and locate the desired file.

  3. Click OK to save the changes.

Though you can always run the Sync Python Requirements to update the requirements file, Aqua provides quick fixes that enable populating this file.

Update the requirements file

  • In an import statement of a Python file, place the caret on the highlighted package and press Alt+Enter. Use the quick-fix suggested by Aqua:

    Quick fix to add a requirement to the requirement.txt file

Specify project dependencies

  1. Open requirements.txt in the editor.

  2. Specify the names of the required packages and their versions.

    When you start typing the package name, Aqua provides completion options:

    Code completion for packages names in requirements.txt

    Press Enter to insert the suggestion.

Aqua provides quick fixes and notifications related to the unsatisfied dependencies.

Install the required packages from requirements.txt

  1. When you open requirements.txt or a Python file on a project that contains requirements.txt, Aqua checks whether all the packages specified in requirements.txt are installed for the current Python interpreter.

    Notification on the requirements

  2. If any packages are missing, a notification bar is displayed at the top of the editor. Click Install requirements.

You can also click Ignore requirements. In this case, you will be able to remove the packages from the list of the ignored packages.

Manage the ignored dependencies

  1. Press Ctrl+Alt+S to open project Settings.

  2. In the main menu, go to Editor | Inspections.

  3. In the list of the inspections, select Unsatisfied package requirements.

  4. Preview the list of the ignored requirements and click the Add icon (Add a package) to add them.

    Adding an ignored package
Last modified: 11 October 2024
Manage project dependenciesManage dependencies using Pipfile