Skip to content

A simple query interface for tabular data that’s light-weight and easy to learn.

License

Notifications You must be signed in to change notification settings

shawnbrown/squint

Repository files navigation

squint: Simple query interface for tabular data

Current Build Status Development Status Apache 2.0 License Supported Python Versions

Squint is a simple query interface for tabular data that's light-weight and easy to learn. A core feature of Squint is that the structure of a query's selection determines the structure of its result. With it you can:

  • Select data using Python literals—sets, lists, dictionaries, etc.—and get results in the same format.
  • Aggregate, map, filter, reduce, and otherwise manipulate data.
  • Lazily iterate over results, write them to a file, or eagerly evaluate them in memory.
  • Analyze data from CSV, Excel, SQL, and other data sources.
Documentation:
Official:
Development:

Some Examples

The examples below will query a CSV file containing the following data (example.csv):

A B C
x foo 20
x foo 30
y foo 10
y bar 20
z bar 10
z bar 10

To begin, we load the CSV file into a Select object:

import squint

select = squint.Select('example.csv')
When you select a The result contains a

single column

select('A')

list of values from that column

['foo',
 'foo',
 'foo',
 'bar',
 'bar',
 'bar']

tuple of columns

select(('A', 'B'))

list of tuples with values from those columns

[('x', 'foo'),
 ('x', 'foo'),
 ('y', 'foo'),
 ('y', 'bar'),
 ('z', 'bar'),
 ('z', 'bar')]

set of columns

select({'A', 'B'})

list of sets with values from those columns

[{'x', 'foo'},
 {'x', 'foo'},
 {'y', 'foo'},
 {'y', 'bar'},
 {'z', 'bar'},
 {'z', 'bar'}]

dictionary of columns

select({'A': 'C'})

dictionary with keys and values from those columns

{'x': [20, 30],
 'y': [10, 20],
 'z': [10, 10]}

(Notice that values are grouped by matching key.)

dictionary with a tuple of column values

select({'A': ('B', 'C')})

dictionary with keys and tuples of values from those columns

{'x': [('foo', 20), ('foo', 30)],
 'y': [('foo', 10), ('bar', 20)],
 'z': [('bar', 10), ('bar', 10)]}

dictionary with a tuple of column keys

select({('A', 'B'): 'C'})

dictionary with tuple keys and values from those columns

{('x', 'foo'): [20, 30],
 ('y', 'foo'): [10],
 ('y', 'bar'): [20],
 ('z', 'bar'): [10, 10]}

Installation

The Squint package is tested on Python 2.7, 3.4 through 3.8, PyPy, and PyPy3; and is freely available under the Apache License, version 2.

The easiest way to install squint is to use pip:

pip install squint

To upgrade an existing installation, use the "--upgrade" option:

pip install --upgrade squint

The development repository for squint is hosted on GitHub. If you need bug-fixes or features that are not available in the current stable release, you can "pip install" the development version directly from GitHub:

pip install --upgrade https://github.com/shawnbrown/squint/archive/master.zip

All of the usual caveats for a development install should apply—only use this version if you can risk some instability or if you know exactly what you're doing. While care is taken to never break the build, it can happen.


Freely licensed under the Apache License, Version 2.0

Copyright 2015 - 2020 National Committee for an Effective Congress, et al.

About

A simple query interface for tabular data that’s light-weight and easy to learn.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages