Skip to content

MeF0504/aftviewer

Repository files navigation

Any File Type Viewer

is a CUI/TUI tool to view any type of files made by Python.

See the wiki page for the details.

Requirements

The basic process of this software is designed to work with standard libraries of recent Python3.
To show some kinds of files, external libraries are required.

e.g.)

The following libraries are not always necessary but are useful if available.

To show images, imaging-related libraries (Currently supporting libraries are PIL (Pillow), Matplotlib, or OpenCV) or shell commands (e.g. "open" in macOS) with supporting bitmap (.bmp) files are required.

Install

python -m pip install git+https://github.com/MeF0504/aftviewer

or in Windows OS,

py -m pip install git+https://github.com/MeF0504/aftviewer

If you want to install all modules used in AFTViewer,

python -m pip install "aftviewer[all] @ git+https://github.com/MeF0504/aftviewer"
# or
py -m pip install "aftviewer[all] @ git+https://github.com/MeF0504/aftviewer"

Usage

usage: aftviewer [-h] [--version] [-t TYPE] file

show the constitution of a file. Supported file types ... hdf5, pickle, numpy,
np_pickle, tar, zip, sqlite3, raw_image, jupyter, xpm, stl, fits. To see the
detailed help of each type, type 'aftviewer help -t TYPE'.

positional arguments:
  file                  input file

options:
  -h, --help            show this help message and exit
  --version, -V         show program's version number and exit
  -t TYPE, --type TYPE  specify the file type. Available types are hdf5,
                        pickle, numpy, np_pickle, tar, zip, sqlite3,
                        raw_image, jupyter, xpm, stl, fits. "aftviewer help -t
                        TYPE" will show the detailed help.

AFTViewer has some subcommands, 'aftviewer help -t TYPE' shows detailed help,
'aftviewer update' run the update command of AFTViewer, 'aftviewer
config_list' shows the current optional configuration, 'aftviewer
shell_completion --bash >> ~/.bashrc' or 'aftviewer shell_completion --zsh >>
~/.zshrc' set the completion script for bash/zsh.

About

CUI view tool made by python.

Resources

License

Stars

Watchers

Forks

Packages

No packages published