https://github.com/shahmal1yev/boo
boo is a command-line interface (CLI) tool designed for managing and updating versions of WordPress plugins. Built with Python's click library, this tool simplifies the process of checking plugin versions, updating individual or multiple plugins, and handling version control tasks efficiently.
https://github.com/shahmal1yev/boo
plugin-manager python wordpress wordpress-plugin-manager
Last synced: 6 months ago
JSON representation
boo is a command-line interface (CLI) tool designed for managing and updating versions of WordPress plugins. Built with Python's click library, this tool simplifies the process of checking plugin versions, updating individual or multiple plugins, and handling version control tasks efficiently.
- Host: GitHub
- URL: https://github.com/shahmal1yev/boo
- Owner: shahmal1yev
- License: mit
- Created: 2024-08-02T21:15:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-23T06:45:34.000Z (about 1 year ago)
- Last Synced: 2024-10-11T03:42:11.377Z (12 months ago)
- Topics: plugin-manager, python, wordpress, wordpress-plugin-manager
- Language: Python
- Homepage: https://shahmal1yev.github.io/boo/
- Size: 256 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Boo Command Line Tool
[](https://opensource.org/licenses/MIT)
`boo` is a command-line interface (CLI) tool built with Python's `click` library. It provides commands to manage versions of wordpress plugins, update them, and handle multiple updates efficiently.
## Installation
To install the required dependencies for this tool, use the `requirements.txt` file:
```bash
pip install -r requirements.txt
```
## Usage
This CLI tool provides the following commands:
### 1. `versions`
Displays the versions of plugins in a specified directory.
**Usage:**
```bash
python your_script.py versions --path= --style=
```
**Options:**
- `--path` (default: `./`): Plugins directory path.
- `--style` (default: `outline`): Set tabulate output style.
### 2. `update`
Updates the version of a specific plugin in a specified directory.
**Usage:**
```bash
python your_script.py update --path= --increase= --decrease= [--commit] [--zip=]
```
**Options:**
- `--path` (default: `./`): Plugin directory path.
- `--increase` (default: `0.0.0`): Increase version of plugins.
- `--decrease` (default: `0.0.0`): Decrease version of plugins.
- `--commit`: Commit changes to Git after updating.
- `--zip`: Path to save the zip files of updated plugins.
### 3. `multi-update`
Performs batch updates on multiple plugins in a specified directory.
**Usage:**
```bash
python your_script.py multi-update --path= --increase= --decrease= [--include=] [--exclude=] [--style=] [--commit] [--zip=]
```
**Options:**
- `--path` (default: `./`): Plugins directory path.
- `--increase` (default: `0.0.0`): Increase version of plugins.
- `--decrease` (default: `0.0.0`): Decrease version of plugins.
- `--include`: Include specific plugins for updating.
- `--exclude`: Exclude specific plugins from updating.
- `--style` (default: `outline`): Set tabulate output style.
- `--commit`: Commit changes to Git after updating.
- `--zip`: Path to save the zip files of updated plugins.
## How to Run
To run any of the commands, use the following syntax:
```bash
python your_script.py [OPTIONS]
```
Replace `` with one of the available commands (`versions`, `update`, `multi-update`), and `[OPTIONS]` with the appropriate options for that command.
## Example
```bash
python your_script.py versions --path="./plugins" --style="outline"
```
This command will list the versions of all plugins in the `./plugins` directory using the `outline` style.
```bash
python your_script.py update --path="./plugin" --increase="1.0.1" --commit
```
This command will update the version of a plugin in the `./plugin` directory to `1.0.1` and commit the changes to Git.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Notes:
1. Replace `your_script.py` with the actual name of your Python script that contains the `boo` class.
2. Add any additional instructions or examples as needed based on your specific use case or setup.