Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
roll committed Sep 23, 2016
1 parent 13cf75e commit 9c5526e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Travis](https://img.shields.io/travis/frictionlessdata/tabulator-py/master.svg)](https://travis-ci.org/frictionlessdata/tabulator-py)
[![Coveralls](http://img.shields.io/coveralls/frictionlessdata/tabulator-py.svg?branch=master)](https://coveralls.io/r/frictionlessdata/tabulator-py?branch=master)
[![PyPi](https://img.shields.io/pypi/v/tabulator.svg)](https://pypi.python.org/pypi/tabulator)
[![SemVer](https://img.shields.io/badge/versions-SemVer-brightgreen.svg)](http://semver.org/)
[![Gitter](https://img.shields.io/gitter/room/frictionlessdata/chat.svg)](https://gitter.im/frictionlessdata/chat)

Consistent interface for stream reading and writing tabular data (csv/xls/json/etc).
Expand All @@ -25,18 +26,23 @@ To get started:
$ pip install tabulator
```

### Quick Start
### Example

Open tabular stream from csv source:

```python
from tabulator import Stream

with Stream('path.csv', headers=1) as stream:
print(stream.headers) # will print headers from 1 row
for row in stream:
print(row) # will print row values list
```

## Documentation

### Stream

`Stream` takes the `source` argument:

```
Expand All @@ -53,9 +59,7 @@ In this example we use context manager to call `stream.open()` on enter and `str
- stream pointer can be set to start via `reset` method
- stream could be saved to filesystem using `save` method

### Advanced Usage

To get full control over the process you can use more parameters. Below the more expanded example is presented:
Below the more expanded example is presented:

```python
from tabulator import Stream
Expand All @@ -82,10 +86,14 @@ stream.save('target.csv')
stream.close()
```

### exceptions

The library provides various of exceptions. Please consult with docstrings.

## Read more

- [Docstrings](https://github.com/frictionlessdata/tabulator-py/tree/master/tabulator)
- [Changelog](https://github.com/frictionlessdata/tabulator-py/releases)
- [Changelog](https://github.com/frictionlessdata/tabulator-py/commits/master)
- [Contribute](CONTRIBUTING.md)

Thanks!

0 comments on commit 9c5526e

Please sign in to comment.