README.md

Datacompy Web UI

A web interface for comparing CSV, TSV, JSON, Parquet, and Excel files using DataCompy. Built with Streamlit.

Features

• Upload and compare CSV and Excel files
• Excel sheet selection for multi-sheet workbooks
• Smart join key recommendations
• Interactive visualization of differences
• Detailed column-by-column analysis
• Row-level comparison with mismatches highlighted

Installation

Recommended (using pipx)

# Install pipx if you haven't already
brew install pipx
pipx ensurepath

# Install DataCompy Web UI
pipx install git+https://github.com/mahangu/datacompy-web-ui.git

Alternative (using pip)

pip install git+https://github.com/mahangu/datacompy-web-ui.git

Upgrading

To upgrade to the latest version:

# Using pipx (recommended)
pipx upgrade datacompy-web-ui

# Or force reinstall from git
pipx install --force git+https://github.com/mahangu/datacompy-web-ui.git

For Development

1. Clone the repository:

git clone https://github.com/mahangu/datacompy-web-ui.git
cd datacompy-web-ui

2. Install development dependencies:

make install

Usage

Command Line

After installation, run:

datacompy-web-ui

This will start the Streamlit server and open the UI in your default browser.

Development Mode

make run

Development

Setup

make install

Code Formatting

# Format code using Black
make format

# Check if code formatting is correct (without making changes)
make check

Running Tests

make test

Note: Tests will fail if code formatting is incorrect. Run make format to fix formatting issues.

Clean Build Files

make clean

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Format your code (make format)
4. Ensure tests pass (make test)
5. Commit your changes (git commit -m 'Add some 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 GNU General Public License v2 (GPLv2).