repvar 0.1.221

Easily replace variables within file contents and filenames!

JSON Variable Replacer CLI (repvar)

This project is a Command Line Interface (CLI) application built using Python and the typer library. It allows you to replace variables in files and filenames within an input folder and save the processed files to an output folder.

Features

• Variable Replacement: Replace variables in the format ${variable} found in file contents and filenames.
• Transformations: Supports variable transformations such as:
  • lowercase: Convert variable value to lowercase.
  • uppercase: Convert variable value to uppercase.
  • nocase: Remove underscores (_) and apply lowercase.
  • remove_: Remove underscores (_).
• Automatic Variable Detection: If no variables JSON file is specified, the application looks for a variables.json file in the input folder.
• Logging Summary: Displays a concise summary with color-coded output, including:
  • Number of files found.
  • Number of files changed.
  • Number of files unchanged.

Installation

Method 1: Install from PyPI

The package is available on PyPI and can be installed directly:

pip install repvar

Method 2: Install from Source

Clone the repository and install the dependencies:

git clone https://github.com/vamanfredi/repvar.git
cd repvar
pip install typer typing-extensions

Method 3: Use uv

Install uv and run the tool installation:

pip install uv
uv tool install --from git+https://github.com/vamanfredi/repvar repvar

Usage

Run the CLI application with the following command:

repvar <input_folder> <output_folder> [variables_json]

Arguments

• <input_folder>: Path to the folder containing the files to process.
• <output_folder>: Path to the folder where processed files will be saved.
• [variables_json]: Optional. Path to the JSON file with variables. Defaults to variables.json in the input folder.

Example

repvar ./input ./output ./variables.json

Example variables.json

{
  "username": "JohnDoe",
  "project": "MyProject",
  "greeting": "Hello"
}

Result

Before replacement:

• Filename: welcome_${username}.txt
• Content: Welcome to ${project}, ${greeting}!

After replacement:

• Filename: welcome_JohnDoe.txt
• Content: Welcome to MyProject, Hello!

Output Example

Upon execution, the CLI will display a summary:

Input Folder: ./input
Output Folder: ./output
Variables Loaded: ['username', 'project', 'greeting']
Files Found: 10
✓ Files Changed: 8
~ Files Unchanged: 2

License

This project is licensed under the MIT License. See the LICENSE file for details.