index.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. .. Tablib documentation master file, created by
  2. sphinx-quickstart on Tue Oct 5 15:25:21 2010.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. Tablib: Pythonic Tabular Datasets
  6. =================================
  7. Release v\ |version|. (:ref:`Installation <install>`)
  8. .. Contents:
  9. ..
  10. .. .. toctree::
  11. .. :maxdepth: 2
  12. ..
  13. .. Indices and tables
  14. .. ==================
  15. ..
  16. .. * :ref:`genindex`
  17. .. * :ref:`modindex`
  18. .. * :ref:`search`
  19. 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.
  20. ::
  21. >>> data = tablib.Dataset(headers=['First Name', 'Last Name', 'Age'])
  22. >>> data.extend([('Kenneth', 'Reitz', 23), ('Bessie', 'Monke', 22)])
  23. >>> data.json
  24. [{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 21}]
  25. >>> data.yaml
  26. - {Age: 22, First Name: Kenneth, Last Name: Reitz}
  27. - {Age: 21, First Name: Bessie, Last Name: Monke}
  28. >>> data.xlsx
  29. <censored binary data>
  30. Testimonials
  31. ------------
  32. `National Geographic <http://www.nationalgeographic.com/>`_,
  33. `Digg, Inc <http://digg.com/>`_,
  34. `Northrop Grumman <http://www.northropgrumman.com/>`_,
  35. `Discovery Channel <http://dsc.discovery.com/>`_,
  36. and `The Sunlight Foundation <http://sunlightfoundation.com/>`_ use Tablib internally.
  37. **Greg Thorton**
  38. Tablib by @kennethreitz saved my life. I had to consolidate like 5 huge poorly maintained lists of domains and data. It was a breeze!
  39. **Dave Coutts**
  40. 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.
  41. **Joshua Ourisman**
  42. Tablib has made it so much easier to deal with the inevitable 'I want an Excel file!' requests from clients...
  43. **Brad Montgomery**
  44. I think you nailed the "Python Zen" with tablib. Thanks again for an awesome lib!
  45. User's Guide
  46. ------------
  47. This part of the documentation, which is mostly prose, begins with some background information about Tablib, then focuses on step-by-step instructions for getting the most out of your datasets.
  48. .. toctree::
  49. :maxdepth: 2
  50. intro
  51. .. toctree::
  52. :maxdepth: 2
  53. install
  54. .. toctree::
  55. :maxdepth: 2
  56. tutorial
  57. .. toctree::
  58. :maxdepth: 2
  59. development
  60. API Reference
  61. -------------
  62. If you are looking for information on a specific function, class or
  63. method, this part of the documentation is for you.
  64. .. toctree::
  65. :maxdepth: 2
  66. api