htmltable-cli 0.1.8

A command line tool to generate html tables with embedded images, videos and audio

htmltable cli

Command line tool to convert lists to portable html tables with embedded audios and images.

Installation

From source (latest)

pip install git+https://github.com/FarisHijazi/htmltable-cli

From pypi (table)

pip install htmltable-cli

Usage

usage: 

A command line tool to generate html tables with embedded images, videos and audio

- Separate columns with `,`
- The easiest way to use it is to put each column in a folder and then pass it using a wildcard `*`

Examples:

    htmltable col1/*.* , col2/*.* , col3/*.* --title "my table" --controls controls preload autoplay loop muted --base64 --index > output.html

    [-h] [--title TITLE] [-c COLNAMES [COLNAMES ...]] [-b] [-x | -fx] [--controls [{controls,preload,autoplay,loop,muted} [{controls,preload,autoplay,loop,muted} ...]]] [-t] [--clamp] data [data ...]

positional arguments:
data                  input table data. Format: col1_item1 col1_item2 col1_item3 , col2_item1 col2_item2 col2_item3 ...

optional arguments:
-h, --help            show this help message and exit
--title TITLE         title heading for the table
-c COLNAMES [COLNAMES ...], --colnames COLNAMES [COLNAMES ...]
                        Provide a list of column names (instead of automatically inferring column names from filepaths).
-b, --base64          Encode all the media to a base64 URL, meaning that the html file is now portable and doesn't depend on the location of the images/audios/videos
-x, --index           add numerical index column
-fx, --filename_index
                        Infer index (rowname) based on row filenames, instead of numerical index. All columns must have identical filenames otherwise an error is raised
--controls [{controls,preload,autoplay,loop,muted} [{controls,preload,autoplay,loop,muted} ...]]
                        HTML video and audio controls
-t, --transpose       swap columns and rows
--clamp               clamp number of rows to the shortest row, ensures the table is symmetric.

Assuming filestructure:

.
|-- col1
|   |-- audio1.wav
|   |-- ...
|   |-- image.png
|   `-- video.mp4
|-- col2
|   |-- audio1.wav
|   |-- ...
|   |-- image.png
|   `-- video.mp4
`-- col3
    |-- audio1.wav
    |-- ...
    |-- image.png
    `-- video.mp4

Examples

Minimal example

htmltable col1/audio1.wav , col2/audio1.wav , col3/audio1.wav > output.html

(you don't actually have to organize your arguments in a new lines :p)

More involved example

htmltable col1/*.* , \
          col2/*.* , \
          col3/*.* \
          --controls controls preload autoplay loop muted \
          --base64 --index > output.html

Explaination

• --base64 will encode all the media to a base64 URL, meaning that the html file is now portable and doesn't depend on the location of the images/audios/videos
• col1/*.* passes all files in col1/ directory
• --controls controls preload autoplay loop muted set default video and audio attributes

Column and row headers

• Column headers are infered automatically, to manually specify columnames, use -c/--colnames
• Row headers options:

  • Can be left blank

  • Indexed numerically using -x/--index

  • Use the filenames, if all files have the same name across columns, using -fx/--filename_index.

    Example: col1/audio1.wav, col2/audio2.wav.

Known issues

• Outputting files is only supported in the . dir. i.e htmltable .... > some/other/path/output.html has issues when not using --base64
• setting --controls autoplay won't work, you need to add muted as well