Metadata-Version: 2.1
Name: csv23
Version: 0.1.4
Summary: Python 2/3 unicode CSV compatibility layer
Home-page: https://github.com/xflr6/csv23
Author: Sebastian Bank
Author-email: sebastian.bank@uni-leipzig.de
License: MIT
Keywords: unicode csv reader writer
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: dev
Requires-Dist: mock; python_version < "3"
Provides-Extra: dev
Requires-Dist: tox (>=3.0); extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pep8-naming; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.3); extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: test
Requires-Dist: mock (>=2); extra == 'test'
Requires-Dist: pytest (>=3.4); extra == 'test'
Requires-Dist: pytest-mock (>=1.8); extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'

csv23
=====

|PyPI version| |License| |Supported Python| |Format| |Docs|

|Travis| |Codecov|

``csv23`` provides the unicode-based API of the Python 3 ``csv`` module for
Python 2 and 3. Code that should run under both versions of Python can use it
to hide the ``bytes`` vs. ``text`` difference between 2 and 3 and stick to the
newer unicode-based interface.

``csv23`` works around for the following bugs in the stdlib ``csv`` module:

bpo-12178_
  broken round-trip with ``escapechar`` if your data contains a literal escape
  character

bpo-31590_
  broken round-trip with ``escapechar`` and embedded newlines under Python 2
  (fixed in Python 3.4 but not backported): produce a warning

The package also provides some convenience functionality such as the
``open_csv()`` context manager for opening a CSV file in the right mode and
returning a ``csv.reader`` or ``csv.writer``:

.. code:: python

    >>> import csv23

    >>> with csv23.open_csv('spam.csv') as reader:  # doctest: +SKIP
    ...     for row in reader:
    ...         print(', '.join(row))
    Spam!, Spam!, Spam!'
    Spam!, Lovely Spam!, Lovely Spam!'

It uses ``utf-8`` as default encoding everywhere.


Links
-----

- GitHub: https://github.com/xflr6/csv23
- PyPI: https://pypi.org/project/csv23/
- Documentation: https://csv23.readthedocs.io
- Changelog: https://csv23.readthedocs.io/en/latest/changelog.html
- Issue Tracker: https://github.com/xflr6/csv23/issues
- Download: https://pypi.org/project/csv23/#files


Installation
------------

This package runs under Python 2.7, and 3.4+, use pip_ to install:

.. code:: bash

    $ pip install csv23


See also
--------

- https://docs.python.org/2/library/csv.html#examples (UnicodeReader, UnicodeWriter)
- https://agate.readthedocs.io/en/latest/api/csv.html
- https://pypi.org/project/backports.csv/
- https://pypi.org/project/csv342/


License
-------

This package is distributed under the `MIT license`_.


.. _bpo-12178: https://bugs.python.org/issue12178
.. _bpo-31590: https://bugs.python.org/issue31590

.. _pip: https://pip.readthedocs.io

.. _MIT license: https://opensource.org/licenses/MIT


.. |--| unicode:: U+2013


.. |PyPI version| image:: https://img.shields.io/pypi/v/csv23.svg
    :target: https://pypi.org/project/csv23/
    :alt: Latest PyPI Version
.. |License| image:: https://img.shields.io/pypi/l/csv23.svg
    :target: https://pypi.org/project/csv23/
    :alt: License
.. |Supported Python| image:: https://img.shields.io/pypi/pyversions/csv23.svg
    :target: https://pypi.org/project/csv23/
    :alt: Supported Python Versions
.. |Format| image:: https://img.shields.io/pypi/format/csv23.svg
    :target: https://pypi.org/project/csv23/
    :alt: Format
.. |Docs| image:: https://readthedocs.org/projects/csv23/badge/?version=stable
    :target: https://csv23.readthedocs.io/en/stable/
    :alt: Readthedocs
.. |Travis| image:: https://img.shields.io/travis/xflr6/csv23.svg
    :target: https://travis-ci.org/xflr6/csv23
    :alt: Travis
.. |Codecov| image:: https://codecov.io/gh/xflr6/csv23/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/xflr6/csv23
    :alt: Codecov