summaryrefslogtreecommitdiffstats
path: root/doc/python/orcus/csv/index.rst
blob: f2b73a071377343cc5c809c319b70d9304bb1f3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
orcus.csv
=========

.. py:function:: orcus.csv.read

   Read an CSV file from a specified file path and create a :py:class:`orcus.Document`
   instance object.

   :param stream: either string value, or file object containing a string stream.
   :rtype: :py:class:`orcus.Document`
   :return: document instance object that stores the content of the file.

   Example::

      from orcus import csv

      with open("path/to/file.csv", "r") as f:
          doc = csv.read(f)