Overview

streamio is a simple library of functions designed to read, write and sort large files using iterators so that the operations will successfully complete on systems with limited RAM. This library has been used extensively at Griffith University whilst developing the TerraNova Climate Change and Adaptation Visualization tool(s) and processing large volumes of data. streamio is written in Python and has extensive documentation and unit tests with 100% coverage.

See the API for a list of the available functions.

Latest PyPI version Number of PyPI downloads Build Status Requirements Status

Examples

Read a large text file iteratively:

from streamio import stream
f = stream("large_file.txt")

Read a large CSV file iteratively:

from streamio import jsonstream
f = stream("large_file.json")

Merge-sort a large JSON file with the key itemgetter("value"):

from operator import itemgetter
from streamio import mergesort
f = mergesort("large_file.json", key=itemgetter("value"))

Requirements

streamio also comes with documentation and a full comprehensive unit test suite which require the following:

To build the docs:

To run the unit tests:

Installation

The simplest and recommended way to install streamio is with pip. You may install the latest stable release from PyPI with pip:

> pip install streamio

If you do not have pip, you may use easy_install:

> easy_install streamio

Alternatively, you may download the source package from the PyPI Page or the Downloads page on the Project Website; extract it and install using:

> python setup.py install

You can also install the latest-development version by using pip or easy_install:

> pip install streamio==dev

or:

> easy_install streamio==dev

For further information see the streamio documentation.

Supported Platforms

  • Linux, FreeBSD, Mac OS X
  • Python 2.7
  • PyPy 2.2
Windows: We acknowledge that Windows exists and make reasonable efforts
to maintain compatibility. Unfortunately we cannot guarantee support at this time.