polars-writer


Namepolars-writer JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/MacHu-GWU/polars_writer-project
Summarypolars_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.
upload_time2024-09-02 03:41:43
maintainerSanhe Hu
docs_urlNone
authorSanhe Hu
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements polars func_args
Travis-CI No Travis.
coveralls test coverage
            
.. .. 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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MacHu-GWU/polars_writer-project",
    "name": "polars-writer",
    "maintainer": "Sanhe Hu",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "husanhe@email.com",
    "keywords": null,
    "author": "Sanhe Hu",
    "author_email": "husanhe@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a6/44/a217f9a84e5b1f887a4f835b96f5d219b791de8fe7403b5acc46057989f1/polars_writer-0.3.2.tar.gz",
    "platform": "Windows",
    "description": "\n.. .. image:: https://readthedocs.org/projects/polars-writer/badge/?version=latest\n    :target: https://polars-writer.readthedocs.io/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/polars_writer-project/actions/workflows/main.yml/badge.svg\n    :target: https://github.com/MacHu-GWU/polars_writer-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/polars_writer-project/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/MacHu-GWU/polars_writer-project\n\n.. image:: https://img.shields.io/pypi/v/polars-writer.svg\n    :target: https://pypi.python.org/pypi/polars-writer\n\n.. image:: https://img.shields.io/pypi/l/polars-writer.svg\n    :target: https://pypi.python.org/pypi/polars-writer\n\n.. image:: https://img.shields.io/pypi/pyversions/polars-writer.svg\n    :target: https://pypi.python.org/pypi/polars-writer\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/polars_writer-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/polars_writer-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n    :target: https://polars-writer.readthedocs.io/en/latest/\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n    :target: https://polars-writer.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n    :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n    :target: https://github.com/MacHu-GWU/polars_writer-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n    :target: https://github.com/MacHu-GWU/polars_writer-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n    :target: https://github.com/MacHu-GWU/polars_writer-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n    :target: https://pypi.org/pypi/polars-writer#files\n\n\nWelcome to ``polars_writer`` Documentation\n==============================================================================\n.. .. image:: https://polars-writer.readthedocs.io/en/latest/_static/polars_writer-logo.png\n    :target: https://polars-writer.readthedocs.io/en/latest/\n\n``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.\n\nSee `Usage example <https://github.com/MacHu-GWU/polars_writer-project/blob/main/tests/test_writer.py>`_\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``polars_writer`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n    $ pip install polars-writer\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n    $ pip install --upgrade polars-writer\n",
    "bugtrack_url": null,
    "license": "MIT",
    "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.",
    "version": "0.3.2",
    "project_urls": {
        "Download": "https://pypi.python.org/pypi/polars_writer/0.3.2#downloads",
        "Homepage": "https://github.com/MacHu-GWU/polars_writer-project"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba55dc4a30783af7ea636ed21ae1b91ec09bd9e52d2580e2d1678bc3838d5858",
                "md5": "d4f4fca53577b42db65aa308c6fa4779",
                "sha256": "9658794b39b73be2fecc16d74077f220738f7d2d35dc7f0d5e3b20dd3e2093b7"
            },
            "downloads": -1,
            "filename": "polars_writer-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d4f4fca53577b42db65aa308c6fa4779",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 10556,
            "upload_time": "2024-09-02T03:41:41",
            "upload_time_iso_8601": "2024-09-02T03:41:41.715694Z",
            "url": "https://files.pythonhosted.org/packages/ba/55/dc4a30783af7ea636ed21ae1b91ec09bd9e52d2580e2d1678bc3838d5858/polars_writer-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a644a217f9a84e5b1f887a4f835b96f5d219b791de8fe7403b5acc46057989f1",
                "md5": "d94bb5e0e2096ab9abb5a768534b08fc",
                "sha256": "847f970bdbb09606fdf52640b8c74f242d4b562fcde56fb4d91e096dbadacc4c"
            },
            "downloads": -1,
            "filename": "polars_writer-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d94bb5e0e2096ab9abb5a768534b08fc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13760,
            "upload_time": "2024-09-02T03:41:43",
            "upload_time_iso_8601": "2024-09-02T03:41:43.083691Z",
            "url": "https://files.pythonhosted.org/packages/a6/44/a217f9a84e5b1f887a4f835b96f5d219b791de8fe7403b5acc46057989f1/polars_writer-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-02 03:41:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MacHu-GWU",
    "github_project": "polars_writer-project",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "polars",
            "specs": [
                [
                    ">=",
                    "1.2.1"
                ],
                [
                    "<",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "func_args",
            "specs": [
                [
                    ">=",
                    "0.1.1"
                ],
                [
                    "<",
                    "1.0.0"
                ]
            ]
        }
    ],
    "lcname": "polars-writer"
}
        
Elapsed time: 0.46146s