Skip to main content

A powerful CLI tool for data format conversion and synthetic data generation

Project description

PyForge CLI

A powerful command-line tool for data format conversion and manipulation, built with Python and Click.

Features

  • PDF to Text Conversion: Extract text from PDF documents with advanced options
  • Excel to Parquet Conversion: Convert Excel files (.xlsx) to Parquet format with multi-sheet support
  • Database File Conversion: Convert Microsoft Access (.mdb/.accdb) and DBF files to Parquet
  • Rich CLI Interface: Beautiful terminal output with progress bars and tables
  • Intelligent Processing: Automatic encoding detection, table discovery, and column matching
  • Extensible Architecture: Plugin-based system for adding new format converters
  • Metadata Extraction: Get detailed information about your files
  • Cross-platform: Works on Windows, macOS, and Linux

Installation

From PyPI

pip install pyforge-cli

From Source

git clone https://github.com/yourusername/pyforge-cli.git
cd pyforge-cli
make install

Development Installation

git clone https://github.com/yourusername/pyforge-cli.git
cd pyforge-cli
make setup-dev

System Dependencies

For MDB/Access file support on non-Windows systems:

# Ubuntu/Debian
sudo apt-get install mdbtools

# macOS
brew install mdbtools

Quick Start

Convert PDF to Text

# Convert entire PDF
pyforge convert document.pdf

# Convert to specific output file
pyforge convert document.pdf output.txt

# Convert specific page range
pyforge convert document.pdf --pages "1-5"

# Include page metadata
pyforge convert document.pdf --metadata

Convert Excel to Parquet

# Convert Excel file to Parquet
pyforge convert data.xlsx

# Convert with specific compression
pyforge convert data.xlsx --compression gzip

# Convert specific sheets only
pyforge convert data.xlsx --sheets "Sheet1,Sheet3"

Convert Database Files

# Convert Access database to Parquet
pyforge convert database.mdb

# Convert DBF file with encoding detection
pyforge convert data.dbf

# Convert with custom output directory
pyforge convert database.accdb output_folder/

Get File Information

# Display file metadata as table
pyforge info document.pdf

# Get Excel file information
pyforge info spreadsheet.xlsx

# Output metadata as JSON
pyforge info database.mdb --format json

List Supported Formats

pyforge formats

Validate Files

pyforge validate document.pdf
pyforge validate data.xlsx

Usage Examples

Basic PDF Conversion

# Convert PDF to text (creates report.txt in same directory)
pyforge convert report.pdf

# Convert with custom output path
pyforge convert report.pdf /path/to/output.txt

# Convert with verbose output
pyforge convert report.pdf --verbose

# Force overwrite existing file
pyforge convert report.pdf output.txt --force

Advanced PDF Options

# Convert pages 1-10
pyforge convert document.pdf --pages "1-10"

# Convert from page 5 to end
pyforge convert document.pdf --pages "5-"

# Convert up to page 10
pyforge convert document.pdf --pages "-10"

# Include page markers in output
pyforge convert document.pdf --metadata

Excel Conversion Examples

# Convert Excel with all sheets
pyforge convert sales_data.xlsx

# Interactive mode - prompts for sheet selection
pyforge convert multi_sheet.xlsx --interactive

# Convert sheets with matching columns into single file
pyforge convert monthly_reports.xlsx --merge-sheets

# Generate summary report
pyforge convert data.xlsx --summary

Database Conversion Examples

# Convert Access database (all tables)
pyforge convert company.mdb

# Convert with progress tracking
pyforge convert large_database.accdb --verbose

# Convert DBF with specific encoding
pyforge convert legacy.dbf --encoding cp1252

# Batch convert all DBF files in directory
for file in *.dbf; do pyforge convert "$file"; done

File Information

# Show file metadata
pyforge info document.pdf

# Excel file details (sheets, row counts)
pyforge info spreadsheet.xlsx

# Database file information (tables, record counts)
pyforge info database.mdb

# Export metadata as JSON
pyforge info document.pdf --format json > metadata.json

Supported Formats

Input Format Output Formats Status
PDF (.pdf) Text (.txt) ✅ Available
Excel (.xlsx) Parquet (.parquet) ✅ Available
Access (.mdb/.accdb) Parquet (.parquet) ✅ Available
DBF (.dbf) Parquet (.parquet) ✅ Available
CSV (.csv) Parquet (.parquet) 🚧 Coming Soon

Development

Setting Up Development Environment

# Clone the repository
git clone https://github.com/yourusername/pyforge-cli.git
cd pyforge-cli

# Set up development environment
make setup-dev

# Run tests
make test

# Format code
make format

# Run all checks
make pre-commit

Available Make Commands

make help              # Show all available commands
make install          # Install package
make install-dev      # Install with development dependencies
make test             # Run tests
make test-cov         # Run tests with coverage
make lint             # Run linting
make format           # Format code
make type-check       # Run type checking
make build            # Build distribution packages
make publish-test     # Publish to Test PyPI
make publish          # Publish to PyPI
make clean            # Clean build artifacts

Project Structure

pyforge-cli/
├── src/cortexpy_cli/
│   ├── __init__.py
│   ├── main.py                  # CLI entry point
│   ├── converters/
│   │   ├── __init__.py
│   │   ├── base.py             # Base converter class
│   │   ├── converter_factory.py # Factory pattern implementation
│   │   ├── pdf_converter.py    # PDF to text conversion
│   │   ├── excel_converter.py  # Excel to Parquet conversion
│   │   ├── mdb_converter.py    # MDB/ACCDB to Parquet conversion
│   │   └── dbf_converter.py    # DBF to Parquet conversion
│   ├── plugins/
│   │   └── loader.py           # Plugin loading system
│   └── utils/
│       ├── file_utils.py       # File type detection
│       └── cli_utils.py        # CLI formatting utilities
├── tests/                      # Test files
├── pyproject.toml             # Project configuration
├── Makefile                   # Development commands
└── README.md                  # This file

Requirements

  • Python 3.8+
  • PyMuPDF (for PDF processing)
  • Click (for CLI interface)
  • Rich (for beautiful terminal output)
  • Pandas & PyArrow (for data processing and Parquet support)
  • pandas-access (for MDB file support)
  • dbfread (for DBF file support)
  • openpyxl (for Excel file support)
  • chardet (for encoding detection)

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests and linting (make pre-commit)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

License

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

Roadmap

Version 0.2.0 - Database & Spreadsheet Support (Completed)

  • Excel to Parquet Conversion
    • Multi-sheet support with intelligent detection
    • Interactive sheet selection mode
    • Column matching for combined output
    • Progress tracking and summary reports
  • MDB/ACCDB to Parquet Conversion
    • Microsoft Access database support (.mdb, .accdb)
    • Automatic table discovery
    • Cross-platform compatibility (Windows/Linux/macOS)
    • Excel summary reports with sample data
  • DBF to Parquet Conversion
    • Automatic encoding detection
    • Support for various DBF formats
    • Robust error handling for corrupted files

Version 0.3.0 - Enhanced Features (Planned)

  • CSV to Parquet conversion with schema inference
  • JSON processing and flattening
  • Data validation and cleaning options
  • Batch processing with pattern matching
  • Configuration file support
  • REST API wrapper for notebook integration
  • Data type preservation options (beyond string conversion)

Version 0.4.0 - Advanced Features (Future)

  • SQL query support for database files
  • Data transformation pipelines
  • Cloud storage integration (S3, Azure Blob)
  • Incremental/delta conversions
  • Custom plugin development SDK

Support

If you encounter any issues or have questions:

  1. Check the documentation
  2. Search existing issues
  3. Create a new issue

Changelog

0.2.1 (Current Release)

  • Fixed GitHub Actions workflow for automated PyPI publishing
  • Updated CI/CD pipeline to use API token authentication
  • Improved package distribution automation

0.2.0 (Current Release)

  • ✅ Excel to Parquet conversion with multi-sheet support
  • ✅ MDB/ACCDB to Parquet conversion with cross-platform support
  • ✅ DBF to Parquet conversion with encoding detection
  • ✅ Interactive mode for Excel sheet selection
  • ✅ Automatic table discovery for database files
  • ✅ Progress tracking with rich terminal UI
  • ✅ Excel summary reports for batch conversions
  • ✅ Robust error handling and recovery

0.1.0 (Initial Release)

  • PDF to text conversion
  • CLI interface with Click
  • Rich terminal output
  • File metadata extraction
  • Page range support
  • Development tooling setup

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyforge_cli-0.2.1.tar.gz (84.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyforge_cli-0.2.1-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file pyforge_cli-0.2.1.tar.gz.

File metadata

  • Download URL: pyforge_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 84.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyforge_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 60a73a17f3fb8b78d64fcc47ca525741ebbe70ae23137b603d774a29dfc48df9
MD5 cd8ac3b5fc267c0cc4304e1e0bee0e20
BLAKE2b-256 9fb2b0dc553186093218770deceab2f6f88f806eacd8d9fbc03a10ca6ff6ba4f

See more details on using hashes here.

File details

Details for the file pyforge_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: pyforge_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyforge_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 40fb65f25fa32d3acbd933c59d719f2b79e51cf33433031e13736ffe63a427c7
MD5 05e842952ee51999dd3f864c6b63e8cb
BLAKE2b-256 76b446d9edbe9d11b7347b8e7c5a080dc288401b5137f94923a5715d28811e4e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page