Metadata-Version: 2.1
Name: polars_writer
Version: 0.3.1
Summary: polars_writer is a library that enables JSON-based configuration of Polars DataFrame writing methods, facilitating language-agnostic data export for end-user facing data products.
Home-page: https://github.com/MacHu-GWU/polars_writer-project
Download-URL: https://pypi.python.org/pypi/polars_writer/0.3.1#downloads
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@email.com
License: MIT
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: polars <2.0.0,>=1.2.1
Requires-Dist: func-args <1.0.0,>=0.1.1
Provides-Extra: docs
Requires-Dist: Sphinx ==5.3.0 ; extra == 'docs'
Requires-Dist: sphinx-jinja ==2.0.2 ; extra == 'docs'
Requires-Dist: sphinx-copybutton ==0.5.1 ; extra == 'docs'
Requires-Dist: sphinx-design ==0.5.0 ; extra == 'docs'
Requires-Dist: furo ==2023.03.27 ; extra == 'docs'
Requires-Dist: nbsphinx ==0.8.12 ; extra == 'docs'
Requires-Dist: rstobj ==1.2.1 ; extra == 'docs'
Requires-Dist: pygments ==2.15.1 ; extra == 'docs'
Requires-Dist: ipython ==8.10.0 ; extra == 'docs'
Requires-Dist: docfly ==2.0.3 ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: deltalake <1.0.0,>=0.18.2 ; extra == 'tests'


.. .. image:: https://readthedocs.org/projects/polars-writer/badge/?version=latest
    :target: https://polars-writer.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/polars_writer-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/polars_writer-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/polars_writer-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/polars_writer-project

.. image:: https://img.shields.io/pypi/v/polars-writer.svg
    :target: https://pypi.python.org/pypi/polars-writer

.. image:: https://img.shields.io/pypi/l/polars-writer.svg
    :target: https://pypi.python.org/pypi/polars-writer

.. image:: https://img.shields.io/pypi/pyversions/polars-writer.svg
    :target: https://pypi.python.org/pypi/polars-writer

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/polars_writer-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/polars_writer-project

------

.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
    :target: https://polars-writer.readthedocs.io/en/latest/

.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://polars-writer.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/polars_writer-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/polars_writer-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/polars_writer-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/polars-writer#files


Welcome to ``polars_writer`` Documentation
==============================================================================
.. .. image:: https://polars-writer.readthedocs.io/en/latest/_static/polars_writer-logo.png
    :target: https://polars-writer.readthedocs.io/en/latest/

``polars_writer`` is a library that allows defining methods like polars.DataFrame.write_csv and polars.DataFrame.write_json using a pure JSON-friendly parameter format. The purpose of this library is to provide an interface independent of the Python language itself, allowing users to directly define the behavior of polars writers using JSON. This library is intended to be used in some end-user facing data products.

See `Usage example <https://github.com/MacHu-GWU/polars_writer-project/blob/main/tests/test_writer.py>`_


.. _install:

Install
------------------------------------------------------------------------------

``polars_writer`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install polars-writer

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade polars-writer
