CVS Pretty Printer¶

https://travis-ci.org/jlubcke/csvpp.png?branch=master

CSV reformatter to align columns

It scratched my particular itch of a massive amount of test code with snippets of CSV data that I wanted to re-format in tidy columns (while retaining the indentation).

Features¶

Reads a CSV file as input and outputs a pretty-printed version with all columns aligned (and indentation retained)

Contents:¶

Installation¶

At the command line either via easy_install or pip:

$ easy_install csvpp
$ pip install csvpp

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv csvpp
$ pip install csvpp

Usage¶

There is a command line version installed with the packag invoked like:

$ cat | csvpp
  foo, bar
  1, 2
^D

The output will be:

foo, bar
1,   2

To use CVS Pretty Printer in a project:

import csvpp

assert csvpp.csvpp(u'  foo, bar\n1, 2\n') == u'  foo, bar\n  1,   2\n'

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/jlubcke/csvpp/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

CVS Pretty Printer could always use more documentation, whether as part of the official CVS Pretty Printer docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/jlubcke/csvpp/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up csvpp for local development.

Fork the csvpp repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/csvpp.git

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

When you’re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:
```
$ tox
```

To get tox, just pip install it.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/jlubcke/csvpp under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test test/test_csvpp.py

Credits¶

Development Lead¶

Johan Lübcke <johan@lubcke.se>

Contributors¶

None yet. Why not be the first?

History¶

0.2.0 (2015.12-14)¶

First release done via travis-ci

0.1.0 (2015-07-08)¶

First release on PyPI.

Feedback¶

If you have any suggestions or questions about CVS Pretty Printer feel free to email me at johan@lubcke.se.

If you encounter any errors or problems with CVS Pretty Printer, please let me know! Open an Issue at the GitHub http://github.com/jlubcke/csvpp main repository.