summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2011-04-05 08:56:20 -0400
committerKenneth Reitz <me@kennethreitz.com>2011-04-05 08:56:20 -0400
commit7ae7d3ff46f323d0d85678cb3415865357ed0e25 (patch)
treea38a88dd2578d37db61e33d36594b812caf7dfa1 /README.rst
parent69ed7181919f327c653d8b155b907df4b33437e5 (diff)
downloadtablib-7ae7d3ff46f323d0d85678cb3415865357ed0e25.tar.gz
Update TODOs
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst48
1 files changed, 26 insertions, 22 deletions
diff --git a/README.rst b/README.rst
index d90f160..a412ec9 100644
--- a/README.rst
+++ b/README.rst
@@ -3,15 +3,15 @@ Tablib: format-agnostic tabular dataset library
::
- _____ ______ ___________ ______
- __ /_______ ____ /_ ___ /___(_)___ /_
+ _____ ______ ___________ ______
+ __ /_______ ____ /_ ___ /___(_)___ /_
_ __/_ __ `/__ __ \__ / __ / __ __ \
/ /_ / /_/ / _ /_/ /_ / _ / _ /_/ /
\__/ \__,_/ /_.___/ /_/ /_/ /_.___/
-Tablib is a format-agnostic tabular dataset library, written in Python.
+Tablib is a format-agnostic tabular dataset library, written in Python.
Output formats supported:
@@ -29,23 +29,23 @@ Overview
`tablib.Dataset()`
A Dataset is a table of tabular data. It may or may not have a header row. They can be build and manipulated as raw Python datatypes (Lists of tuples|dictionaries). Datasets can be imported from JSON, YAML, and CSV; they can be exported to Excel (XLS), JSON, YAML, and CSV.
-
+
`tablib.Databook()`
A Databook is a set of Datasets. The most common form of a Databook is an Excel file with multiple spreadsheets. Databooks can be imported from JSON and YAML; they can be exported to Excel (XLS), JSON, and YAML.
Usage
-----
-
+
Populate fresh data files: ::
-
+
headers = ('first_name', 'last_name')
data = [
('John', 'Adams'),
('George', 'Washington')
]
-
+
data = tablib.Dataset(*data, headers=headers)
@@ -56,12 +56,12 @@ Intelligently add new rows: ::
Intelligently add new columns: ::
>>> data.append(col=(90, 67, 83), header='age')
-
+
Slice rows: ::
>>> print data[:2]
[('John', 'Adams', 90), ('George', 'Washington', 67)]
-
+
Slice columns by header: ::
@@ -77,7 +77,7 @@ Exports
Drumroll please...........
-JSON!
+JSON!
+++++
::
@@ -94,26 +94,26 @@ JSON!
"first_name": "Henry"
}
]
-
-YAML!
+
+YAML!
+++++
::
>>> print data.yaml
- {age: 90, first_name: John, last_name: Adams}
- {age: 83, first_name: Henry, last_name: Ford}
-
-CSV...
+
+CSV...
++++++
::
>>> print data.csv
- first_name,last_name,age
- John,Adams,90
- Henry,Ford,83
-
-EXCEL!
+ first_name,last_name,age
+ John,Adams,90
+ Henry,Ford,83
+
+EXCEL!
++++++
::
@@ -128,15 +128,17 @@ Installation
To install tablib, simply: ::
$ pip install tablib
-
+
Or, if you absolutely must: ::
$ easy_install tablib
-
+
Contribute
----------
-If you'd like to contribute, simply fork `the repository`_, commit your changes to the **develop** branch (or branch off of it), and send a pull request. Make sure you add yourself to AUTHORS_.
+If you'd like to contribute, simply fork `the repository`_, commit your
+changes to the **develop** branch (or branch off of it), and send a pull
+request. Make sure you add yourself to AUTHORS_.
Roadmap
@@ -145,6 +147,8 @@ Roadmap
v1.0.0:
- Add hooks system
- Tablib.ext namespace
+ - Better 2.x/3.x handling (currently internal codebase fork)
+ - Width detection on XLS out
.. _`the repository`: http://github.com/kennethreitz/tablib