https://github.com/shir0kamii/flask-csv

Easily render CSVs within any flask application
https://github.com/shir0kamii/flask-csv

api csv flask flask-extensions

Last synced: about 2 months ago
JSON representation

Easily render CSVs within any flask application

• Host: GitHub
• URL: https://github.com/shir0kamii/flask-csv
• Owner: Shir0kamii
• License: mit
• Created: 2017-05-03T19:21:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-10T00:10:34.000Z (about 1 year ago)
• Last Synced: 2024-09-23T19:07:54.707Z (3 months ago)
• Topics: api, csv, flask, flask-extensions
• Language: Python
• Size: 17.6 KB
• Stars: 20
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
#########

Flask-CSV

#########

Easily render CSVs within any flask application

Install

#######

Flask-CSV is packaged and you can use pip to install it::

    pip install flask_csv

How to use ?

############

Flask-CSV has a simple hepler method named `send_csv` which allows you to send

csv files in flask endpoints. It takes an iterable of `dict`, a filename and a

list of fields. The keys of all `dict` in the iterable must correspond to

given fields.

It will return a `Response` object with filename set and body containing the

CSV data.

You will better understand with a short example.

.. code-block:: python

    @app.route("/")

    def index():

        return send_csv([{"id": 42, "foo": "bar"}, {"id": 91, "foo": "baz"}],

                        "test.csv", ["id", "foo"])

Hitting this endpoint will return::

    id,foo

    42,bar

    91,baz

Passing additionnal parameters

##############################

The remaining arguments of `send_csv` will be passed to `send_file`. For

example, to disable caching, do the following:

.. code-block:: python

    send_csv([{"id": 42, "foo": "bar"}, {"id": 91, "foo": "baz"}],

             "test.csv", ["id", "foo"], cache_timeout=0)

You can also pass additionnal parameters to the CSV writer like this:

.. code-block:: python

    send_csv([{"foo": 42}, {"bar": "baz"}], "test.csv", ["foo"],

             writer_kwargs={"extrasaction": "ignore"})

In this example, the "bar" key will not raise a `ValueError` since the writer

will be given the parameter `extrasaction` with the value "ignore".

Change delimiter

################

You can also change the delimiter with the `delimiter` option.

.. code-block:: python

    send_csv([{"id": 42, "foo": "bar"}, {"id": 91, "foo": "baz"}],

             "test.csv", ["id", "foo"], delimiter=';')

Will result in::

    id;foo

    42;bar

    91;baz

Specifying file encoding

########################

You can also specify the encoding used to send the file, with the `encoding` option (`utf-8` by default).

.. code-block:: python

    send_csv([{"id": 42, "foo": "bar"}, {"id": 91, "foo": "baz"}],

             "test.csv", ["id", "foo"], encoding='iso-8859-1')

Use Marshmallow Schemas

#######################

You can use `Schema` from marshmallow by passing it as `schema` to `send_csv`.

If you want to keep only ids and ensure they are integers, you could do:

.. code-block:: python

    class IdSchema(Schema):

        id = fields.Integer()

    send_csv([{"id": 42, "foo": "bar"}, {"id": 91, "foo": "baz"}],

             "test.csv", ["id", "foo"], schema=IdSchema())

And that would result in this::

    id

    42

    91

SystemError returned a result with an error set

###############################################

When using uwsgi for your flask app, it might raise this kind of error on the send_file method.

If that were the case, adding the following option to your uwsgi conf should solve it :

`wsgi-disable-file-wrapper = true`