=====
csvpy
=====

Description
===========

Loads a CSV file into a :class:`csvkit.CSVKitReader` object and then drops into a Python shell so the user can inspect the data however they see fit::

    usage: csvpy [-h] [-d DELIMITER] [-t] [-q QUOTECHAR] [-u {0,1,2,3}] [-b]
                 [-p ESCAPECHAR] [-z MAXFIELDSIZE] [-e ENCODING] [-v]
                 FILE

    Load a CSV file into a CSVKitReader object and then drops into a Python shell.

    positional arguments:
      FILE                  The CSV file to operate on.

    optional arguments:
      -h, --help            show this help message and exit
      --dict                Use CSVKitDictReader instead of CSVKitReader.

This utility will automatically use the IPython shell if it is installed, otherwise it will use the running Python shell.

.. note::

    Due to platform limitations, csvpy does not accept file input on STDIN. 

Also see: :doc:`common_arguments`.

Examples
========

Basic use::

    $ csvpy examples/dummy.csv
    Welcome! "examples/dummy.csv" has been loaded in a CSVKitReader object named "reader".
    >>> reader.next()
    [u'a', u'b', u'c']

As a dictionary::

    $ csvpy --dict examples/dummy.csv -v
    Welcome! "examples/dummy.csv" has been loaded in a CSVKitDictReader object named "reader".
    >>> reader.next()
    {u'a': u'1', u'c': u'3', u'b': u'2'}