README.md

Zipssion

What is this?

More about this repository

This project is just getting started and only has a couple of features implemented! I intend to use semantic versioning for zipssion, but for now consider it to be version 0.1.0-alpha (a prerelease state.)

Known issues / TODOs

• List out commands
• Generate documentation
• Write getting started guide
• Currently, zipssion is using python-magic (libmagic) for file identification but I want to add a flag that allows the user to use Magika instead. (or maybe in addition to?)
• Write tests
• Continue writing TODOs...

View source

Planned Usage (incomplete/wip)

Usage:
main.py <file> [--quiet | --verbose] [--path=<path>] [--extention=<file extention>]
main.py (-h | --help)
main.py --version
main.py --quiet
main.py --verbose

Options:
-h --help      show help text
--version      show version
--quiet        print less text
--verbose      print more text
--path=<path>  list of file paths [default: {'/'}]
--extention=<file extention>  the file's extention (if known)

Credits, inspiration, and references

Articles, guides, and resources

• Command Line Interface Guidelines

Libraries used by zipssion

• Typer
• rich-cli
• python-magic

Tools

• Python Black
• isort

Fun things/Other

• Readme Typing

Things I'm saving for latter possible use

• pyfiglet
• asciinema
• Magika

🔝

License