Skip to main content

Print csv files in columnated format, either plain or as a Markdown or LaTeX table

Project description

csvprint

Build Status codecov

A command-line utility for pretty printing csv files and converting to other formats.

Installation

If Python 3 with the package manager pip is installed, doing pip3 install csvprint in your terminal should do the trick.

Development installation

With pipenv installed.

  1. Clone this repo
  2. Do pipenv install
  3. pipenv shell
  4. pip install -e .

Usage

csvprint [filename] prints a formatted table if filename is a comma separated file.

» cat imdb.csv
Title,Release Year,Estimated Budget
Shawshank Redemption,1994,$25 000 000
The Godfather,1972,$6 000 000
The Godfather: Part II,1974,$13 000 000
The Dark Knight,2008,$185 000 000
12 Angry Men,1957,$350 000

» csvprint imdb.csv
Title                  Release Year Estimated Budget
Shawshank Redemption   1994         $25 000 000
The Godfather          1972         $6 000 000
The Godfather: Part II 1974         $13 000 000
The Dark Knight        2008         $185 000 000
12 Angry Men           1957         $350 000

You can also pipe into csvprint:

» cat imdb.csv | csvprint
Title                  Release Year Estimated Budget
Shawshank Redemption   1994         $25 000 000
The Godfather          1972         $6 000 000
The Godfather: Part II 1974         $13 000 000
The Dark Knight        2008         $185 000 000
12 Angry Men           1957         $350 000

Options

Command Result
-a specify alignment (left or right) - see examples below
-c specify which columns to print
-h print help message
--markdown print as markdown
--latex print as latex table
--numeric [c1:d1] [c2:d2] ... specify decimal numbers for chosen numeric columns (c for column, d for digits)
--header add header decoration around the first line
-s 'char' file is delimited by char (instead of comma), tab for tab
-p [n] add a padding of n spaces for each column, on both sides
-d [string] specify the string to separate columns

Alignment example

There are three options for specifying alignment. One can use l or r for aligning all cells to the left or right, respectively. One can also specify a distinct alignment option for each column. Then the number of options will need to match the number of columns.

» csvprint imdb.csv -a l r r
Title                  Release Year Estimated Budget
Shawshank Redemption           1994      $25 000 000
The Godfather                  1972       $6 000 000
The Godfather: Part II         1974      $13 000 000
The Dark Knight                2008     $185 000 000
12 Angry Men                   1957         $350 000

Markdown example

Markdown output also supports left and right alignment.

» csvprint examples/imdb.csv --markdown -a l r r
Title                  | Release Year | Estimated Budget
:----------------------|-------------:|----------------:
Shawshank Redemption   |         1994 |      $25 000 000
The Godfather          |         1972 |       $6 000 000
The Godfather: Part II |         1974 |      $13 000 000
The Dark Knight        |         2008 |     $185 000 000
12 Angry Men           |         1957 |         $350 000

When rendered as HTML, this looks like

Title Release Year Estimated Budget
Shawshank Redemption 1994 $25 000 000
The Godfather 1972 $6 000 000
The Godfather: Part II 1974 $13 000 000
The Dark Knight 2008 $185 000 000
12 Angry Men 1957 $350 000

Numeric example

» csvprint examples/numeric.csv
measure1  measure2
1.2323    9000
1.299     9000001

» csvprint examples/numeric.csv --numeric 1:1 2:1
measure1  measure2
1.2       9000.0
1.3       9000001.0

Testing

Run pytest while in the root directory of this repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for csvprint, version 0.7.1
Filename, size File type Python version Upload date Hashes
Filename, size csvprint-0.7.1-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size csvprint-0.7.1.tar.gz (7.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page