Home

Welcome to the PyViewer wiki!

Introduction

This is a CUI/TUI tool to view any kind of packaged, archived, or binary files made by Python.

Usage

usage: pyviewer [-h] [--version]
                [-t {hdf5,pickle,numpy,np_pickle,tar,zip,sqlite3,raw_image,jupyter,xpm}]
                file

show the constitution of a file. Supported file types ... hdf5, pickle, numpy,
np_pickle, tar, zip, sqlite3, raw_image, jupyter, xpm. To see the detailed
help of each type, type 'pyviewer 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 {hdf5,pickle,numpy,np_pickle,tar,zip,sqlite3,raw_image,jupyter,xpm}, --type {hdf5,pickle,numpy,np_pickle,tar,zip,sqlite3,raw_image,jupyter,xpm}
                        specify the file type. "pyviewer help -t TYPE" will
                        show the detailed help.

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

Requirements

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

e.g.)

• numpy for numpy, xpm, np_pickle
• h5py for hdf5
• rawpy for raw_image

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

• numpy for hdf5
• tabulate for sqlite3

To show images, some imaging-related libraries (e.g. PIL (Pillow), matplotlib or OpenCV) or shell commands (e.g. "open" in macOS) are required.

Installation

pip command is available.

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

or in Windows OS,

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

If you want to install all modules used in PyViewer,

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