Metadata-Version: 2.1
Name: chardif
Version: 0.1.3
Summary: Print per-character string diffs to terminal w/ Python
Home-page: https://github.com/shaypal5/chardif
Author: Shay Palachy
Author-email: shay.palachy@gmail.com
License: MIT
Description: chardif
        #######
        
        |PyPI-Status| |PyPI-Versions| |Build-Status| |Codefactor| |LICENCE|
        
        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.
        
        
        .. role:: python(code)
          :language: python
        
        .. image:: https://raw.githubusercontent.com/shaypal5/chardif/master/chardif_example.png?sanitize=true
        
        
        .. contents::
        
        .. section-numbering:
        
        
        Installation
        ============
        
        Install ``chardif`` with:
        
        .. code-block:: python
        
            pip install chardif
        
        
        Use
        ===
        
        Just a single function, folks:
        
        .. code-block:: python
        
          from chardif import chardif
          import datetime
        
          chardif("rabbits", "grab it")
        
        
        Contributing
        ============
        
        Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.
        
        Installing for development
        --------------------------
        
        Clone:
        
        .. code-block:: bash
        
          git clone git@github.com:shaypal5/chardif.git
        
        
        Install in development mode with test dependencies:
        
        .. code-block:: bash
        
          cd chardif
          pip install -e ".[test]"
        
        
        Running the tests
        -----------------
        
        To run the tests, call the ``pytest`` command in the repository's root, or:
        
        .. code-block:: bash
        
          python -m pytest
        
        
        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`_.
        
        .. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        .. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        
        
        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 (shay.palachy@gmail.com).
        
        .. _`gist`: https://gist.github.com/ines/04b47597eb9d011ade5e77a068389521
        .. _`wasabi`: https://pypi.org/project/wasabi/
        .. _`ines`: https://gist.github.com/ines
        
        .. |PyPI-Status| image:: https://img.shields.io/pypi/v/chardif.svg
          :target: https://pypi.python.org/pypi/chardif
        
        .. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/chardif.svg
           :target: https://pypi.python.org/pypi/chardif
        
        .. |Build-Status| image:: https://travis-ci.org/shaypal5/chardif.svg?branch=master
          :target: https://travis-ci.org/shaypal5/chardif
        
        .. |LICENCE| image:: https://img.shields.io/badge/License-MIT-ff69b4.svg
          :target: https://pypi.python.org/pypi/chardif
        
        .. |Codecov| image:: https://codecov.io/github/shaypal5/chardif/coverage.svg?branch=master
           :target: https://codecov.io/github/shaypal5/chardif?branch=master
        
        .. |Downloads| image:: https://pepy.tech/badge/chardif
             :target: https://pepy.tech/project/chardif
             :alt: PePy stats
        
        .. |Codefactor| image:: https://www.codefactor.io/repository/github/shaypal5/chardif/badge?style=plastic
             :target: https://www.codefactor.io/repository/github/shaypal5/chardif
             :alt: Codefactor code quality
        
Keywords: diff,wasabi,chardiff
Platform: linux
Platform: osx
Platform: windows
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Topic :: Other/Nonlisted Topic
Classifier: Intended Audience :: Developers
Provides-Extra: test
