Merge branch 'release/0.9.8'v0.9.8

8 files changed, 151 insertions, 44 deletions

diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
new file mode 100644
index 0000000..470ce04
--- /dev/null
+++ b/docs/_templates/sidebarintro.html
@@ -0,0 +1,20 @@
+<h3><a href="http://tablib.org">About Tablib</a></h3>
+<p>
+  Tablib is an MIT Licensed format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & export.
+</p>
+
+<h3>Feedback</h3>
+<p>
+  Feedback is greatly appreciated. If you have any questions, comments,
+  random praise, or anonymous threats, <a href="mailto:me@kennethreitz.com">
+  shoot me an email</a>.
+</p>
+
+
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="http://tablib.org/">The Tablib Website</a></li>
+  <li><a href="http://pypi.python.org/pypi/tablib">Tablib @ PyPI</a></li>
+  <li><a href="http://github.com/kennethreitz/tablib">Tablib @ GitHub</a></li>
+  <li><a href="http://github.com/kennethreitz/tablib/issues">Issue Tracker</a></li>
+</ul>
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
new file mode 100644
index 0000000..573da08
--- /dev/null
+++ b/docs/_templates/sidebarlogo.html
@@ -0,0 +1,4 @@
+<h3><a href="http://tablib.org">About Tablib</a></h3>
+<p>
+  Tablib is an MIT Licensed format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & export.
+</p>
\ No newline at end of file
diff --git a/docs/_themes/kr/layout.html b/docs/_themes/kr/layout.html
index 7e76548..344ec29 100644
--- a/docs/_themes/kr/layout.html
+++ b/docs/_themes/kr/layout.html
@@ -9,10 +9,12 @@
 {% endblock %}
 {%- block relbar2 %}{% endblock %}
 {%- block footer %}
-    <div class="footer">
+  <div class="footer">
       &copy; Copyright {{ copyright }}.
-      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
+    <a href="https://github.com/kennethreitz/tablib">
+        <img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" />
+    </a>
     <script type="text/javascript">
 
       var _gaq = _gaq || [];
diff --git a/docs/_themes/kr/static/flasky.css_t b/docs/_themes/kr/static/flasky.css_t
index 5c2cb7e..7477b3f 100644
--- a/docs/_themes/kr/static/flasky.css_t
+++ b/docs/_themes/kr/static/flasky.css_t
@@ -8,11 +8,11 @@
 
 {% set page_width = '940px' %}
 {% set sidebar_width = '220px' %}
- 
+
 @import url("basic.css");
- 
+
 /* -- page layout ----------------------------------------------------------- */
- 
+
 body {
     font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro';
     font-size: 17px;
@@ -43,7 +43,7 @@ div.sphinxsidebar {
 hr {
     border: 1px solid #B1B4B6;
 }
- 
+
 div.body {
     background-color: #ffffff;
     color: #3E4349;
@@ -54,7 +54,7 @@ img.floatingflask {
     padding: 0 0 10px 10px;
     float: right;
 }
- 
+
 div.footer {
     width: {{ page_width }};
     margin: 20px auto 30px auto;
@@ -70,7 +70,7 @@ div.footer a {
 div.related {
     display: none;
 }
- 
+
 div.sphinxsidebar a {
     color: #444;
     text-decoration: none;
@@ -80,7 +80,7 @@ div.sphinxsidebar a {
 div.sphinxsidebar a:hover {
     border-bottom: 1px solid #999;
 }
- 
+
 div.sphinxsidebar {
     font-size: 14px;
     line-height: 1.5;
@@ -95,7 +95,7 @@ div.sphinxsidebarwrapper p.logo {
     margin: 0;
     text-align: center;
 }
- 
+
 div.sphinxsidebar h3,
 div.sphinxsidebar h4 {
     font-family: 'Garamond', 'Georgia', serif;
@@ -109,7 +109,7 @@ div.sphinxsidebar h4 {
 div.sphinxsidebar h4 {
     font-size: 20px;
 }
- 
+
 div.sphinxsidebar h3 a {
     color: #444;
 }
@@ -120,7 +120,7 @@ div.sphinxsidebar p.logo a:hover,
 div.sphinxsidebar h3 a:hover {
     border: none;
 }
- 
+
 div.sphinxsidebar p {
     color: #555;
     margin: 10px 0;
@@ -131,25 +131,25 @@ div.sphinxsidebar ul {
     padding: 0;
     color: #000;
 }
- 
+
 div.sphinxsidebar input {
     border: 1px solid #ccc;
     font-family: 'Georgia', serif;
     font-size: 1em;
 }
- 
+
 /* -- body styles ----------------------------------------------------------- */
- 
+
 a {
     color: #004B6B;
     text-decoration: underline;
 }
- 
+
 a:hover {
     color: #6D4100;
     text-decoration: underline;
 }
- 
+
 div.body h1,
 div.body h2,
 div.body h3,
@@ -161,25 +161,25 @@ div.body h6 {
     margin: 30px 0px 10px 0px;
     padding: 0;
 }
- 
+
 div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
 div.body h2 { font-size: 180%; }
 div.body h3 { font-size: 150%; }
 div.body h4 { font-size: 130%; }
 div.body h5 { font-size: 100%; }
 div.body h6 { font-size: 100%; }
- 
+
 a.headerlink {
     color: #ddd;
     padding: 0 4px;
     text-decoration: none;
 }
- 
+
 a.headerlink:hover {
     color: #444;
     background: #eaeaea;
 }
- 
+
 div.body p, div.body dd, div.body li {
     line-height: 1.4em;
 }
@@ -226,20 +226,20 @@ div.note {
     background-color: #eee;
     border: 1px solid #ccc;
 }
- 
+
 div.seealso {
     background-color: #ffc;
     border: 1px solid #ff6;
 }
- 
+
 div.topic {
     background-color: #eee;
 }
- 
+
 p.admonition-title {
     display: inline;
 }
- 
+
 p.admonition-title:after {
     content: ":";
 }
@@ -333,7 +333,7 @@ ul, ol {
     margin: 10px 0 10px 30px;
     padding: 0;
 }
- 
+
 pre {
     background: #eee;
     padding: 7px 30px;
@@ -350,7 +350,7 @@ dl dl pre {
     margin-left: -90px;
     padding-left: 90px;
 }
- 
+
 tt {
     background-color: #ecf0f3;
     color: #222;
@@ -388,7 +388,7 @@ a:hover tt {
 
 
 @media screen and (max-width: 600px) {
-    
+
     div.sphinxsidebar {
     	display: none;
     }
@@ -423,8 +423,42 @@ a:hover tt {
     	width: auto;
     }
 
-    
-    
+
+
 }
 
 
+
+/* scrollbars */
+
+::-webkit-scrollbar {
+    width: 6px;
+    height: 6px;
+}
+
+::-webkit-scrollbar-button:start:decrement,
+::-webkit-scrollbar-button:end:increment {
+    display: block;
+    height: 10px;
+}
+
+::-webkit-scrollbar-button:vertical:increment {
+    background-color: #fff;
+}
+
+::-webkit-scrollbar-track-piece {
+    background-color: #eee;
+    -webkit-border-radius: 3px;
+}
+
+::-webkit-scrollbar-thumb:vertical {
+    height: 50px;
+    background-color: #ccc;
+    -webkit-border-radius: 3px;
+}
+
+::-webkit-scrollbar-thumb:horizontal {
+    width: 50px;
+    background-color: #ccc;
+    -webkit-border-radius: 3px;
+}
diff --git a/docs/conf.py b/docs/conf.py
index 5a42816..d0c7ae6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,14 +41,14 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Tablib'
-copyright = u'2011, Kenneth Reitz. Styles (modified) &copy; Armin Ronacher'
+copyright = u'2011. A <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> Project'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.9.7'
+version = '0.9.8'
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -131,7 +131,11 @@ html_static_path = ['static']
 html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    'index':    ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
+    '**':       ['sidebarlogo.html', 'localtoc.html', 'relations.html',
+                 'sourcelink.html', 'searchbox.html']
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
diff --git a/docs/index.rst b/docs/index.rst
index 77ce7cf..25ceb85 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,20 +3,20 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Tablib: Pythonic Tabular Datasets 
+Tablib: Pythonic Tabular Datasets
 =================================
 
-Release |version|.
+Release v\ |version|. (:ref:`Installation <install>`)
 
 .. Contents:
-.. 
+..
 .. .. toctree::
 ..    :maxdepth: 2
-.. 
+..
 
 .. Indices and tables
 .. ==================
-.. 
+..
 .. * :ref:`genindex`
 .. * :ref:`modindex`
 .. * :ref:`search`
@@ -24,7 +24,47 @@ Release |version|.
 
 Tablib is an :ref:`MIT Licensed <mit>` format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & export.
 
-I recommend you start with :ref:`Installation <install>`.
+::
+
+   >>> data = tablib.Dataset(headers=['First Name', 'Last Name', 'Age'])
+   >>> map(data.append, [('Kenneth', 'Reitz', 22), ('Bessie', 'Monke', 21)])
+
+   >>> data.json
+   [{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 21}]
+
+   >>> data.yaml
+   - {Age: 22, First Name: Kenneth, Last Name: Reitz}
+   - {Age: 21, First Name: Bessie, Last Name: Monke}
+
+   >>> data.xlsx
+   <censored binary data>
+
+
+Testimonials
+------------
+
+`The Library of Congress <http://www.loc.gov/>`_,
+`National Geographic <http://www.nationalgeographic.com/>`_,
+`Digg, Inc <http://digg.com/>`_,
+`Northrop Grumman <http://www.northropgrumman.com/>`_,
+`Discovery Channel <http://dsc.discovery.com/>`_,
+`The Sunlight Foundation <http://sunlightfoundation.com/>`_, and
+`NetApp, Inc <http://netapp.com>`_ use Tablib internally.
+
+
+
+**Greg Thorton**
+   Tablib by @kennethreitz saved my life. I had to consolidate like 5 huge poorly maintained lists of domains and data. It was a breeze!
+
+**Dave Coutts**
+   It's turning into one of my most used modules of 2010. You really hit a sweat spot for managing tabular data with a minimal amount of code and effort.
+
+**Joshua Ourisman**
+   Tablib has made it so much easier to deal with the inevitable 'I want an Excel file!' requests from clients...
+
+**Brad Montgomery**
+    I think you nailed the "Python Zen" with tablib. Thanks again for an awesome lib!
+
 
 User's Guide
 ------------
diff --git a/docs/intro.rst b/docs/intro.rst
index 719133d..971afbd 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -3,7 +3,7 @@
 Introduction
 ============
 
-This part of the documentation covers all the interfaces of Tablib. 
+This part of the documentation covers all the interfaces of Tablib.
 Tablib is a format-agnostic tabular dataset library, written in Python. It allows you to Pythonically import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags / filtering, and seamless format import/export.
 
 
@@ -26,15 +26,17 @@ All contributions to Tablib should keep these important rules in mind.
 MIT License
 -----------
 
-A large number of open source projects you find today are `GPL Licensed`_. While the GPL has its time and place, it should most certainly not be your go-to license for your next open source project. 
+A large number of open source projects you find today are `GPL Licensed`_. While the GPL has its time and place, it should most certainly not be your go-to license for your next open source project.
 
-A project that is released as GPL cannot be used in any commercial product without the product itself also being offered as open source. The MIT and BSD licenses are great alternatives to the GPL that allow your open-source software to be used in proprietary, closed-source software. 
+A project that is released as GPL cannot be used in any commercial product without the product itself also being offered as open source. The MIT, BSD, and ISC licenses are great alternatives to the GPL that allow your open-source software to be used in proprietary, closed-source software.
 
 Tablib is released under terms of `The MIT License`_.
 
 .. _`GPL Licensed`: http://www.opensource.org/licenses/gpl-license.php
 .. _`The MIT License`: http://www.opensource.org/licenses/mit-license.php
 
+.. note::
+    Tablib will be moved to the `Apache 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_ upon the release of v1.0.0.
 
 .. _license:
 
@@ -67,7 +69,7 @@ THE SOFTWARE.
 Pythons Supported
 -----------------
 
-At this time, the following Python platforms are officially supported: 
+At this time, the following Python platforms are officially supported:
 
 * cPython 2.5
 * cPython 2.6
@@ -75,6 +77,7 @@ At this time, the following Python platforms are officially supported:
 * cPython 3.1
 * cPython 3.2
 * PyPy-c 1.4
+* PyPy-c 1.5
 
 Support for other Pythons will be rolled out soon.
 
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 07939c2..6d50db5 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -259,7 +259,7 @@ Let's tag some students. ::
 Now that we have extra meta-data on our rows, we can use easily filter our :class:`Dataset`. Let's just see Male students. ::
 
 
-    >>> data.filter(['male']).yaml
+    >>> students.filter(['male']).yaml
     - {first: Kenneth, Last: Reitz}
 
 It's that simple. The original :class:`Dataset` is untouched.