chardif 0.0.1

Print per-character string diffs to terminal w/ Python

Print per-character string diffs to terminal w/ Python.

Done using wasabi, and based on a gist by ines (which is also the writer of wasabi). And in “based” I mean it’s just that gist in a package form.

Contents

• Installation

• Use

• Contributing

  • Installing for development

  • Running the tests

  • Adding documentation

• Credits

Installation

Install chardif with:

pip install chardif

Use

Just a single function, folks:

from chardif import chardif
import datetime

chardif("rabbits", "grab it")

Contributing

Package author and current maintainer is Shay Palachy ([e-mail]); You are more than welcome to approach him for help. Contributions are very welcomed.

Installing for development

Clone:

git clone [e-mail]:shaypal5/chardif.git

Install in development mode with test dependencies:

cd chardif
pip install -e ".[test]"

Running the tests

To run the tests, call the pytest command in the repository’s root, or:

python -m pytest

To run only pickle core related tests, use:

pytest -m mongo

Adding documentation

This project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings (in my personal opinion, of course). When documenting code you add to this project, please follow these conventions.

Credits

Done using wasabi, and based on a gist by ines (which is also the writer of wasabi). And in “based” I mean it’s just that gist in a package form.

Created by Shay Palachy ([e-mail]).