text2file 0.1.4

A utility to generate test files in various formats from text content

Text2File

A powerful utility to generate test files in various formats from text content. Perfect for testing, development, and automation tasks.

Table of Contents

• Features
• Installation
  • Using pip (recommended)
  • From source
• Usage
  • Basic Syntax
  • Available Commands
  • Examples
• File Format Examples
  • Text Files
  • Code Files
  • Documents
  • Spreadsheets
  • Images
  • Archives
• API Reference
• Development
• Contributing
• License

Features

• 🚀 Generate files in multiple formats with a single command
• 📄 Support for various file types:
  • Text: .txt, .md, .html, .css, .js, .py, .json, .csv
  • Documents: .pdf, .docx, .odt
  • Spreadsheets: .xlsx
  • Images: .jpg, .jpeg, .png, .bmp, .gif, .svg
  • Archives: .zip, .tar, .tar.gz, .tgz
• ✅ File validation to ensure generated files are not corrupted
• 🔄 Clean up invalid files with a single command
• 📂 Customizable output directory and filename prefix
• 🔍 Recursive directory scanning for validation and cleanup
• 🛠️ Extensible architecture for adding new file formats
• 🧪 Built-in testing and validation

Installation

Using pip (recommended)

pip install text2file

From source

1. Clone the repository:

   git clone https://github.com/veridock/text2file.git
   cd text2file
   

2. Install with Poetry (recommended):

   poetry install
   

   Or with pip:

   pip install .
   

Usage

Basic Syntax

text2file [COMMAND] [OPTIONS]

Available Commands

• generate - Generate files in various formats
• generate-set - Generate a set of images from a JSON configuration
• validate - Validate generated files
• cleanup - Clean up invalid files
• --version - Show version and exit
• --help - Show help message and exit

Examples

Generate a text file

text2file "Hello, World!" txt

text2file generate --content "Hello, World!" --extension txt

This will create a file named output.txt with the content "Hello, World!" in the current directory.

Generate a set of images from a JSON configuration

Create a JSON file (e.g., icons.json) with the following format:

{
  "icons": [
    {"src": "icon-16x16.png", "sizes": "16x16"},
    {"src": "icon-32x32.png", "sizes": "32x32"},
    {"src": "icon-64x64.png", "sizes": "64x64"}
  ]
}

Then run:

# Generate placeholder images with default text
text2file generate-set icons.json

# Use a base image and resize it
text2file generate-set icons.json --base-image source-icon.png

# Customize the placeholder appearance
text2file generate-set icons.json --text "My App" --background-color "#f0f0f0" --text-color "#333333"

Options:

• -o, --output-dir: Output directory (default: current directory)
• -b, --base-image: Base image to use for resizing (optional)
• --bg, --background-color: Background color for placeholders (default: "#ffffff")
• -t, --text: Text to render on placeholder images
• --fg, --text-color: Text color for placeholders (default: "#000000")

Generate multiple files with different formats

text2file generate --content "Sample content" --extension txt,md,html --output-dir ./output

Validate generated files

text2file validate --path ./output --recursive --verbose

Clean up invalid files

text2file cleanup --path ./output --recursive --dry-run

File Format Examples

Text Files

Plain Text (.txt)

text2file generate --content "This is a plain text file" --extension txt

Markdown (.md)

content="# Sample Markdown\n\n- Item 1\n- Item 2\n- Item 3"
text2file generate --content "$content" --extension md

Code Files

Python (.py)

content="def hello_world():\n    print('Hello, World!')\n\nif __name__ == '__main__':\n    hello_world()"
text2file generate --content "$content" --extension py

JavaScript (.js)

content="function helloWorld() {\n  console.log('Hello, World!');\n}\n\nhelloWorld();"
text2file generate --content "$content" --extension js

Documents

PDF (.pdf)

text2file generate --content "This is a sample PDF document" --extension pdf

Word Document (.docx)

text2file generate --content "This is a sample Word document" --extension docx

Spreadsheets

Excel (.xlsx)

content="Name,Age,City\nJohn,30,New York\nAlice,25,London"
text2file generate --content "$content" --extension xlsx

Image Sets

Generate multiple images from a JSON configuration file. This is useful for creating icon sets or multiple resolutions of the same image.

JSON Configuration Format

Create a file (e.g., icons.json) with the following structure:

{
  "icons": [
    {
      "src": "icon-16x16.png",
      "sizes": "16x16"
    },
    {
      "src": "icon-32x32.png",
      "sizes": "32x32"
    },
    {
      "src": "subdir/icon-64x64.png",
      "sizes": "64x64"
    }
  ]
}

Each entry in the icons array should have:

• src: Output file path (relative to output directory)
• sizes: Dimensions in format "WIDTHxHEIGHT" (e.g., "32x32")

Usage Examples

# Generate placeholder images with default text
text2file generate-set icons.json

# Use a base image and resize it
text2file generate-set icons.json --base-image source-icon.png

# Customize the placeholder appearance
text2file generate-set icons.json --text "My App" --background-color "#f0f0f0" --text-color "#333333"

# Specify output directory
text2file generate-set icons.json --output-dir ./output

Options

• -o, --output-dir: Output directory (default: current directory)
• -b, --base-image: Base image to use for resizing (optional)
• --bg, --background-color: Background color for placeholders (default: "#ffffff")
• -t, --text: Text to render on placeholder images
• --fg, --text-color: Text color for placeholders (default: "#000000")

Single Images

JPEG (.jpg, .jpeg)

text2file generate --content "Sample image content" --extension jpg --width 800 --height 600

PNG (.png)

text2file generate --content "Sample image content" --extension png --width 800 --height 600

SVG Image (.svg)

text2file generate --content "Sample SVG" --extension svg

# With custom dimensions (width x height)
text2file generate --content "Custom Size" --extension svg --width 400 --height 200

Archives

ZIP (.zip)

text2file generate --content "Sample content for archive" --extension zip

TAR.GZ (.tar.gz)

text2file generate --content "Sample content for tar.gz archive" --extension tar.gz

API Reference

text2file.generate_file(content: str, extension: str, output_dir: str = ".", filename: Optional[str] = None) -> str

Generate a file with the given content and extension.

Parameters

• content: The content to write to the file
• extension: The file extension (without dot)
• output_dir: Output directory (default: current directory)
• filename: Optional custom filename (without extension)

Returns

• Path to the generated file

text2file.validate_file(filepath: str) -> bool

Validate if a file is not corrupted.

Parameters

• filepath: Path to the file to validate

Returns

• True if file is valid, False otherwise

text2file.cleanup_invalid_files(directory: str, recursive: bool = False, dry_run: bool = False) -> List[str]

Remove invalid files from a directory.

Parameters

• directory: Directory to clean up
• recursive: Whether to scan subdirectories
• dry_run: If True, only show what would be deleted

Returns

• List of removed files

Development

Prerequisites

• Python 3.8+
• Poetry

Setup

1. Clone the repository:

   git clone https://github.com/veridock/text2file.git
   cd text2file
   

2. Install dependencies:

   poetry install
   

3. Activate the virtual environment:

   poetry shell
   

Running Tests

pytest

Linting and Formatting

# Run linter
ruff check .

# Format code
black .

# Check types
mypy .

Contributing

Contributions are welcome! Please read our Contributing Guidelines for details on how to contribute to this project.

License

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

Commands

Generate Files

text2file generate "Your text content" [EXTENSIONS...] [OPTIONS]

Options:

• -o, --output-dir PATH: Output directory (default: current directory)
• -p, --prefix TEXT: Filename prefix (default: "generated")
• --help: Show help message and exit

Examples:

1. Generate a simple text file:

   text2file generate "This is a test file" txt
   

2. Generate multiple file formats at once:

   text2file generate "Sample content" txt md pdf jpg
   

3. Custom output directory and prefix:

   text2file generate "Test content" -o ./output -p custom_ txt pdf
   

Validate Files

text2file validate PATH [OPTIONS]

Options:

• -r, --recursive: Recursively validate files in subdirectories
• -v, --verbose: Show detailed validation results
• --json: Output results in JSON format
• --help: Show help message and exit

Examples:

1. Validate a single file:

   text2file validate document.pdf
   

2. Validate all files in a directory recursively:

   text2file validate ./test_files -r
   

3. Get detailed validation output in JSON:

   text2file validate ./test_files --json
   

Clean Up Invalid Files

text2file cleanup PATH [OPTIONS]

Options:

• -r, --recursive: Recursively clean up files in subdirectories
• --dry-run: Show what would be deleted without actually deleting
• -v, --verbose: Show detailed information
• --help: Show help message and exit

Examples:

1. Clean up invalid files in a directory:

   text2file cleanup ./test_files
   

2. Preview what would be deleted (dry run):

   text2file cleanup ./test_files --dry-run -v
   

File Format Examples

Text Files (.txt, .md)

text2file generate "# Markdown Title\n\nThis is a **markdown** file with *formatting*.\n\n- Item 1\n- Item 2\n- Item 3" md

Code Files (.py, .js, .html)

text2file generate "def hello_world():\n    print('Hello, World!')" py

Images (.jpg, .png)

text2file generate "Sample text to be converted to image" jpg png

Documents (.pdf, .docx)

text2file generate "Formal Document\n\nThis is a sample document with multiple paragraphs. The text will be automatically wrapped to fit the output format. Great for creating test data!" pdf docx

Development

Setup

1. Install development dependencies:

   poetry install --with dev
   

2. Run tests:

   poetry run pytest
   

3. Run linter:

   poetry run ruff check .
   

4. Run formatter:

   poetry run black .
   

Adding New File Formats

1. Create a new generator function in src/text2file/generators/
2. Add validation logic in src/text2file/validators.py if needed
3. Register the generator in src/text2file/__init__.py
4. Add tests in tests/
5. Update documentation

Contributing

Contributions are welcome! Please read our Contributing Guidelines for details.

License

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

Changelog

See CHANGELOG.md for a history of changes.