Skip to content

Repository files navigation

convashun 🟢

Continuous Integration PyPI version License: MIT Supported Platforms

⚡ Ultra-fast, zero-config, cross-platform file conversion utility optimized for developers, documentation teams, and automated robotics data pipelines.

Built entirely on top of modern Python type hints (Typer), blazingly fast package architecture (uv), and robust data utilities. Developed with love for open-source engineering workflows and engineered to seamlessly support the data tracking, documentation, and asset conversion pipelines of communities like Aurora Robotics.


📊 Conversion Matrix

convashun maps target conversions dynamically using deep binary validation rather than flimsy extension strings.

Category Input Formats Targeted Output Command Pure Python? System Dependencies
Images JPG, PNG, WEBP, BMP, GIF, TIFF convert image to-png Yes None
Images JPG, PNG, WEBP, BMP, GIF, TIFF convert image to-webp Yes None
Images JPG, PNG, WEBP, BMP, GIF, TIFF convert image to-jpg Yes None
Spreadsheets CSV (Comma Separated Log files) convert document to-xlsx Yes None
Spreadsheets XLSX (Multi-sheet spreadsheet layouts) convert document xlsx-to-csv Yes None
Documentation PDF Documents convert document to-docx Yes None
Documentation PDF Documents convert document to-markdown Yes None
Documentation Markdown Markup File (.md) convert document markdown-to-pdf Yes None
Office/Academics DOCX, DOC, ODT, PPTX convert document to-pdf No LibreOffice
Office/Academics PowerPoint Presentations (.pptx) convert document pptx-to-pdf No LibreOffice
Office/Academics LaTeX Documents (.tex) convert document tex-to-pdf Yes None

🚀 Quick Start & Installation

convashun works identically across Windows, macOS, and Linux distributions.

Method 1: Using uv (Highly Recommended)

Install convashun instantly into an isolated, globally accessible environment managed entirely by uv:

uv tool install convashun

Method 2: Standard Installation via PyPI

pip install convashun
# Or use pipx to isolate system paths cleanly
pipx install convashun

🛠️ Usage Examples

Once installed, use the global entry command convert directly in your terminal interface:

🖼️ Image Operations

# Convert an image into WebP format with custom compression quality settings
convert image to-webp input_graphic.png --quality 85

# Flatten a complex transparent asset safely into a JPG with a solid white backing
convert image to-jpg transparent_blueprint.png

# Optimize a standard PNG file size automatically without changing resolution parameters
convert image to-png photographic_capture.jpg --optimize

📄 Document Layouts & Spreadsheet Processing

# Compile a Markdown README specification file directly into a portable PDF manual
convert document markdown-to-pdf ARCHITECTURE.md

# Extract telemetry or configuration records from an Excel document directly down to a CSV log
convert document xlsx-to-csv metrics_workbook.xlsx --sheet "TelemetryLogs"

# Convert an uneditable PDF report layout back into a semantic Markdown string file
convert document to-markdown datasheet_report.pdf

📦 System Prerequisites (For Office Documents Only)

Commands such as to-pdf (for .docx and .pptx) use automated background processes to render layout definitions precisely. If a command prompts you with a missing dependency, install LibreOffice on your path using your platform package engine:

  • macOS: brew install libreoffice
  • Linux (Ubuntu/Debian): sudo apt install libreoffice
  • Windows (PowerShell WinGet): winget install LibreOffice.LibreOffice

🟢 Open Source Contributions

We value input from engineering collaborators and the robotics community!

To add optimization modules or extend format parsers:

  1. Review our structured guidelines inside CONTRIBUTING.md.
  2. Set up your local sandboxed tracking workspace via uv:
    git clone https://github.com
    cd convashun
    uv sync --dev
  3. Run the complete automated multi-OS testing validation matrix locally before pushing changes:
    uv run pytest

📄 License

Distributed safely under the terms of the open-source MIT License. Check out LICENSE for exact operational data guidelines.

About

A Ultra-fast, zero-config, cross-platform file conversion utility optimized for developers, documentation teams, and automated robotics data pipelines.

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages