Skip to content

anthonybench/convert

Repository files navigation

sleepyconvert

A quick way to convert file formats.


Welcome to sleepyconvert!

Do you find yourself bookmarking various online converters or having several tools to convert common file types? I did, and it didn't spark joy.

sleepyconvert is a tool that handles this in a minimal syntax.

Quickly convert file formats to and from:

  • data
    • csv
    • parquet
    • json
    • pkl
    • xlsx
  • img
    • png
    • jpg/jpeg
  • doc
    • html
    • pdf
    • md

For some data files, you can optionally compress (gzip) the output.

ℹ️ Note that this tool presumes format by file extension. If you leave out extensions, or give csv data a .json extension for funsies, then you're being silly.

ℹ️ Due to how document file formats vary, not all functionality can be preserved from one type to another, and formatting 1-1-ness may vary.


Get Started 🚀

pip install sleepyconvert
pip install --upgrade sleepyconvert

python -m sleepyconvert --help
python -m sleepyconvert data data.csv data.parquet --compress
python -m sleepyconvert img photo.png photo.jpg
python -m sleepyconvert doc photo.html photo.pdf

Usage ⚙

Set a function in your shell environment to run a script like:

alias convert='python -m sleepyconvert'

Presuming you've named said macro convert, print the help message:

convert --help
convert data data.csv data.parquet
convert img photo.png photo.jpg
convert doc photo.html photo.pdf

Technologies 🧰


Contribute 🤝

If you have thoughts on how to make the tool more pragmatic, submit a PR 😊.

To add support for more data/file types:

  1. append extension name to supported_<mode>_formats in sleepyconvert_toolchain.params.py
  2. add detection logic branch to the main function in sleepyconvert_toolchain/commands.py
  3. update this readme

License, Stats, Author 📜

example image tag

PyPI - License PyPI - Version GitHub repo size

See License for the full license text.

This package was authored by Isaac Yep.
👉 GitHub
👉 PyPI

About

A quick way to convert data, document, and image formats.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages