https://github.com/rtech91/drupal-scout

Search for Drupal module entries with transitive core version requirements to help to upgrade the Drupal Core
https://github.com/rtech91/drupal-scout

drupal drupal-module

Last synced: 2 months ago
JSON representation

Search for Drupal module entries with transitive core version requirements to help to upgrade the Drupal Core

• Host: GitHub
• URL: https://github.com/rtech91/drupal-scout
• Owner: rtech91
• License: mit
• Created: 2023-06-03T17:06:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2026-03-30T18:19:27.000Z (3 months ago)
• Last Synced: 2026-03-30T20:26:04.027Z (3 months ago)
• Topics: drupal, drupal-module
• Language: Python
• Homepage: https://pypi.org/project/drupal-scout/
• Size: 142 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Drupal Scout

Search for Drupal module entries with transitive core version requirements to help to upgrade the Drupal Core

## Installation

```bash

  pip install drupal-scout

```

## Features

- Use multithreading to speed up the process of searching for the Drupal module entries with transitive core version requirements.

- Quick self-diagnostic check of the environment and dependencies using the `info` command.

- Choose between three output formats: table, json, and suggest.  

    - `table` format will output the data in the table format.  

    Example:

    ![Table format example](https://raw.githubusercontent.com/rtech91/drupal-scout/main/screenshots/format_table_example.png)

    - `json` format will output the raw data in the json format.  

    - `suggest` format will output the suggested composer.json file with the updated module version requirements.  

    It will also dump the suggested composer.json file to the specified path if the `--save-dump` argument is used.

## Limitations

- The application will only work with Composer-based (Composer v2) Drupal 8+ projects. 

## Usage/Examples

`drupal-scout [-h] [-v] [-d DIRECTORY] [-n] [-t THREADS] [-f {table,json,suggest}] [-s] {info} ...`

### Arguments

‐ `-h, --help` show this help message and exit  

– `-v, --version` show program's version number and exit  

– `-d DIRECTORY, --directory DIRECTORY`  Directory of the Drupal installation  

– `-n, --no-lock` Do not use the composer.lock file to determine the installed versions of the modules  

– `-t THREADS, --threads THREADS` The number of threads to use for the concurrent requests and data parsing. By default, the application will use the number of all available threads.  

– `-f {table,json,suggest}, --format {table,json,suggest}` The output format. By default, the application will use the table format.  

– `-s, --save-dump` Use in pair with `--format suggest` to dump the suggested composer.json file to the specified path. 

### Subcommands

– `info` - show diagnostic information about the tool and the current Drupal environment.