drupal-scout


Namedrupal-scout JSON
Version 1.0.2 PyPI version JSON
download
home_page
SummaryScout out for transitive versions of Drupal modules for the upgrade of the core.
upload_time2023-07-14 11:40:09
maintainer
docs_urlNone
author
requires_python>=3.10
licenseMIT License Copyright (c) 2023 Andrew Tsyhaniuk Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords drupal scout upgrade core transitive dependencies
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.
- 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] [-d DIRECTORY] [-n] [-t THREADS] [-f {table,json,suggest}] [-s]`

### Arguments
‐ `-h, --help` show this help message 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. 

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "drupal-scout",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "drupal,scout,upgrade,core,transitive,dependencies",
    "author": "",
    "author_email": "\"Andrew [R-Tech] Tsyhaniuk\" <in0mad91@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d0/24/dfb84bb5d1929fed9d711fd1c43352ab56ab51004070f4e22f4c303ec6c9/drupal-scout-1.0.2.tar.gz",
    "platform": null,
    "description": "# Drupal Scout\n\nSearch for Drupal module entries with transitive core version requirements to help to upgrade the Drupal Core\n\n## Installation\n\n```bash\n  pip install drupal-scout\n```\n\n## Features\n\n- Use multithreading to speed up the process of searching for the Drupal module entries with transitive core version requirements.\n- Choose between three output formats: table, json, and suggest.  \n    - `table` format will output the data in the table format.  \n    Example:\n    ![Table format example](https://raw.githubusercontent.com/rtech91/drupal-scout/main/screenshots/format_table_example.png)\n    - `json` format will output the raw data in the json format.  \n    - `suggest` format will output the suggested composer.json file with the updated module version requirements.  \n    It will also dump the suggested composer.json file to the specified path if the `--save-dump` argument is used.\n\n## Limitations\n\n- The application will only work with Composer-based (Composer v2) Drupal 8+ projects. \n    \n## Usage/Examples\n\n`drupal-scout [-h] [-d DIRECTORY] [-n] [-t THREADS] [-f {table,json,suggest}] [-s]`\n\n### Arguments\n&dash; `-h, --help` show this help message and exit  \n&ndash; `-d DIRECTORY, --directory DIRECTORY`  Directory of the Drupal installation  \n&ndash; `-n, --no-lock` Do not use the composer.lock file to determine the installed versions of the modules  \n&ndash; `-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.  \n&ndash; `-f {table,json,suggest}, --format {table,json,suggest}` The output format. By default, the application will use the table format.  \n&ndash; `-s, --save-dump` Use in pair with `--format suggest` to dump the suggested composer.json file to the specified path. \n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Andrew Tsyhaniuk  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Scout out for transitive versions of Drupal modules for the upgrade of the core.",
    "version": "1.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/rtech91/drupal-scout/issues",
        "Homepage": "https://github.com/rtech91/drupal-scout"
    },
    "split_keywords": [
        "drupal",
        "scout",
        "upgrade",
        "core",
        "transitive",
        "dependencies"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7175764afe849762b8d840c212be981be4d1ee552ba194160ec0ef0ab2bac892",
                "md5": "d861a29227345652d8b359e10a1bc9c7",
                "sha256": "dfddcde2f6132674a2193677114e6a4d5dc0c297b3fb81195a3fd026b0349d23"
            },
            "downloads": -1,
            "filename": "drupal_scout-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d861a29227345652d8b359e10a1bc9c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 14675,
            "upload_time": "2023-07-14T11:40:07",
            "upload_time_iso_8601": "2023-07-14T11:40:07.242650Z",
            "url": "https://files.pythonhosted.org/packages/71/75/764afe849762b8d840c212be981be4d1ee552ba194160ec0ef0ab2bac892/drupal_scout-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d024dfb84bb5d1929fed9d711fd1c43352ab56ab51004070f4e22f4c303ec6c9",
                "md5": "405f6f296004be372742fa80795a9283",
                "sha256": "993586078c67018f6a75a44cff02fc00d8daf6b191d84034de4a0db03928d492"
            },
            "downloads": -1,
            "filename": "drupal-scout-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "405f6f296004be372742fa80795a9283",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11517,
            "upload_time": "2023-07-14T11:40:09",
            "upload_time_iso_8601": "2023-07-14T11:40:09.638730Z",
            "url": "https://files.pythonhosted.org/packages/d0/24/dfb84bb5d1929fed9d711fd1c43352ab56ab51004070f4e22f4c303ec6c9/drupal-scout-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-14 11:40:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rtech91",
    "github_project": "drupal-scout",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "drupal-scout"
}
        
Elapsed time: 0.09198s