diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_templates/sidebarintro.html | 4 | ||||
| -rw-r--r-- | docs/_templates/sidebarlogo.html | 2 | ||||
| -rw-r--r-- | docs/_themes/kr/layout.html | 6 | ||||
| -rw-r--r-- | docs/development.rst | 27 | ||||
| -rw-r--r-- | docs/index.rst | 8 | ||||
| -rw-r--r-- | docs/install.rst | 10 | ||||
| -rw-r--r-- | docs/tutorial.rst | 13 |
7 files changed, 39 insertions, 31 deletions
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index 470ce04..a87a69a 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -1,4 +1,4 @@ -<h3><a href="http://tablib.org">About Tablib</a></h3> +<h3><a href="http://docs.python-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> @@ -13,7 +13,7 @@ <h3>Useful Links</h3> <ul> - <li><a href="http://tablib.org/">The Tablib Website</a></li> + <li><a href="http://docs.python-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> diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html index 573da08..a7bfa65 100644 --- a/docs/_templates/sidebarlogo.html +++ b/docs/_templates/sidebarlogo.html @@ -1,4 +1,4 @@ -<h3><a href="http://tablib.org">About Tablib</a></h3> +<h3><a href="http://docs.python-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 696413a..1431b49 100644 --- a/docs/_themes/kr/layout.html +++ b/docs/_themes/kr/layout.html @@ -15,6 +15,12 @@ <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" src="//www.hellobar.com/hellobar.js"></script> + <script type="text/javascript"> + new HelloBar(36402,48802); + </script> + <script type="text/javascript"> var _gaq = _gaq || []; diff --git a/docs/development.rst b/docs/development.rst index 90bdb43..1124e9f 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -46,7 +46,7 @@ Source Control Tablib source is controlled with Git_, the lean, mean, distributed source control machine. -The repository is publicly accessable. +The repository is publicly accessible. ``git clone git://github.com/kennethreitz/tablib.git`` @@ -67,11 +67,11 @@ Feature / Hotfix / Release branches follow a `Successful Git Branching Model`_ . ``master`` Current production release (|version|) on PyPi. ``gh-pages`` - Current release of http://tablib.org. + Current release of http://docs.python-tablib.org. Each release is tagged. -When submitting patches, please place your feature/change in its own branch prior to opening a pull reqeust on GitHub_. +When submitting patches, please place your feature/change in its own branch prior to opening a pull request on GitHub_. .. _Git: http://git-scm.org @@ -132,7 +132,7 @@ Tablib features a micro-framework for adding format support. The easiest way to 2. - Add your new format module to the :class:`tablib.formats.avalable` tuple. + Add your new format module to the :class:`tablib.formats.available` tuple. 3. Add a mock property to the :class:`Dataset <tablib.Dataset>` class with verbose `reStructured Text`_ docstring. This alleviates IDE confusion, and allows for pretty auto-generated Sphinx_ documentation. @@ -174,20 +174,15 @@ This will generate a **nosetests.xml** file, which can then be analyzed. Continuous Integration ---------------------- -Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Jenkins CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly. +Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Travis CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly. Anyone may view the build status and history at any time. - http://ci.kennethreitz.com/ - - -If you are trustworthy and plan to contribute to tablib on a regular basis, please contact `Kenneth Reitz`_ to get an account on the Jenkins Server. - + https://travis-ci.org/kennethreitz/tablib Additional reports will also be included here in the future, including :pep:`8` checks and stress reports for extremely large datasets. -.. _`Jenkins CI`: http://jenkins-ci.org/ -.. _`Kenneth Reitz`: http://kennethreitz.com/contact-me/ +.. _`Jenkins CI`: https://travis-ci.org/ .. _docs: @@ -210,13 +205,13 @@ Then, to build an HTML version of the docs, simply run the following from the ** Your ``docs/_build/html`` directory will then contain an HTML representation of the documentation, ready for publication on most web servers. -You can also generate the documentation in **ebpub**, **latex**, **json**, *&c* similarly. +You can also generate the documentation in **epub**, **latex**, **json**, *&c* similarly. .. admonition:: GitHub Pages To push the documentation up to `GitHub Pages`_, you will first need to run `sphinx-to-github`_ against your ``docs/_build/html`` directory. - GitHub Pages are powered by an HTML generation system called Jeckyl_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**). + GitHub Pages are powered by an HTML generation system called Jekyll_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**). @@ -238,9 +233,9 @@ You can also generate the documentation in **ebpub**, **latex**, **json**, *&c* .. _`reStructured Text`: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org .. _`GitHub Pages`: http://pages.github.com -.. _Jeckyl: http://github.com/mojombo/jekyll +.. _Jekyll: http://github.com/mojombo/jekyll .. _`sphinx-to-github`: http://github.com/michaeljones/sphinx-to-github ---------- -Make sure to check out the :ref:`API Documentation <api>`.
\ No newline at end of file +Make sure to check out the :ref:`API Documentation <api>`. diff --git a/docs/index.rst b/docs/index.rst index e0e4166..7bf1a41 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,8 +26,8 @@ Tablib is an :ref:`MIT Licensed <mit>` format-agnostic tabular dataset library, :: - >>> data = tablib.Dataset(headers=['First Name', 'Last Name', 'Age']) - >>> map(data.append, [('Kenneth', 'Reitz', 22), ('Bessie', 'Monke', 21)]) + >>> data = tablib.Dataset(*[('Kenneth', 'Reitz', 23), ('Bessie', 'Monke', 22)], + headers=['First Name', 'Last Name', 'Age']) >>> data.json [{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 21}] @@ -55,7 +55,7 @@ and `The Sunlight Foundation <http://sunlightfoundation.com/>`_ use Tablib inter 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. + It's turning into one of my most used modules of 2010. You really hit a sweet 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... @@ -99,4 +99,4 @@ method, this part of the documentation is for you. .. toctree:: :maxdepth: 2 - api
\ No newline at end of file + api diff --git a/docs/install.rst b/docs/install.rst index 48c6267..9df8ee8 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -2,7 +2,7 @@ Installation ============ -This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed. Please read this section carefully, or you may miss out on some nice :ref:`speed enhancements <peed-extentions>`. +This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed. Please read this section carefully, or you may miss out on some nice :ref:`speed enhancements <peed-extensions>`. .. _installing: @@ -22,7 +22,7 @@ or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_:: $ easy_install tablib -But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/index.html#pip-compared-to-easy-install>`_. +But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_. @@ -57,15 +57,15 @@ To download the full source history from Git, see :ref:`Source Control <scm>`. .. _zipball: http://github.com/kennethreitz/tablib/zipball/master -.. _speed-extentions: -Speed Extentions +.. _speed-extensions: +Speed Extensions ---------------- .. versionadded:: 0.8.5 Tablib is partially dependent on the **pyyaml**, **simplejson**, and **xlwt** modules. To reduce installation issues, fully integrated versions of all required libraries are included in Tablib. -However, if performance is important to you (and it should be), you can install **pyyaml** with C extentions from PyPi. :: +However, if performance is important to you (and it should be), you can install **pyyaml** with C extensions from PyPi. :: $ pip install PyYAML diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 561b24c..bd2dbc0 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -68,7 +68,7 @@ Adding Headers -------------- -It's time enhance our :class:`Dataset` by giving our columns some titles. To do so, set :class:`Dataset.headers`. :: +It's time to enhance our :class:`Dataset` by giving our columns some titles. To do so, set :class:`Dataset.headers`. :: data.headers = ['First Name', 'Last Name'] @@ -146,6 +146,13 @@ To do so, we access the :class:`Dataset` as if it were a standard Python diction >>> data['First Name'] ['Kenneth', 'Bessie'] +You can also access the column using its index. :: + + >>> d.headers + ['Last Name', 'First Name', 'Age'] + >>> d.get_col(1) + ['Kenneth', 'Bessie'] + Let's find the average age. :: >>> ages = data['Age'] @@ -244,7 +251,7 @@ Filtering Datasets with Tags When constructing a :class:`Dataset` object, you can add tags to rows by specifying the ``tags`` parameter. -This allows you to filter your :class:`Dataset` later. This can be useful so separate rows of data based on +This allows you to filter your :class:`Dataset` later. This can be useful to separate rows of data based on arbitrary criteria (*e.g.* origin) that you don't want to include in your :class:`Dataset`. Let's tag some students. :: @@ -256,7 +263,7 @@ Let's tag some students. :: students.rpush(['Kenneth', 'Reitz'], tags=['male', 'technical']) students.rpush(['Bessie', 'Monke'], tags=['female', 'creative']) -Now that we have extra meta-data on our rows, we can use easily filter our :class:`Dataset`. Let's just see Male students. :: +Now that we have extra meta-data on our rows, we can easily filter our :class:`Dataset`. Let's just see Male students. :: >>> students.filter(['male']).yaml |