index.rst 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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 `MIT Licensed <https://mit-license.org/>`_ format-agnostic tabular dataset library, written in Python.
  20. It allows you to import, export, and manipulate tabular data sets.
  21. Advanced features include segregation, dynamic columns, tags & filtering,
  22. and seamless format import & export.
  23. ::
  24. >>> data = tablib.Dataset(headers=['First Name', 'Last Name', 'Age'])
  25. >>> for i in [('Kenneth', 'Reitz', 22), ('Bessie', 'Monke', 21)]:
  26. ... data.append(i)
  27. >>> print(data.export('json'))
  28. [{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 21}]
  29. >>> print(data.export('yaml'))
  30. - {Age: 22, First Name: Kenneth, Last Name: Reitz}
  31. - {Age: 21, First Name: Bessie, Last Name: Monke}
  32. >>> data.export('xlsx')
  33. <redacted binary data>
  34. >>> data.export('df')
  35. First Name Last Name Age
  36. 0 Kenneth Reitz 22
  37. 1 Bessie Monke 21
  38. Testimonials
  39. ------------
  40. `National Geographic <https://www.nationalgeographic.com/>`_,
  41. `Digg, Inc <https://digg.com/>`_,
  42. `Northrop Grumman <https://www.northropgrumman.com/>`_,
  43. `Discovery Channel <https://dsc.discovery.com/>`_,
  44. and `The Sunlight Foundation <https://sunlightfoundation.com/>`_ use Tablib internally.
  45. **Greg Thorton**
  46. Tablib by @kennethreitz saved my life.
  47. I had to consolidate like 5 huge poorly maintained lists of domains and data.
  48. It was a breeze!
  49. **Dave Coutts**
  50. It's turning into one of my most used modules of 2010.
  51. You really hit a sweet spot for managing tabular data with a minimal amount of code and effort.
  52. **Joshua Ourisman**
  53. Tablib has made it so much easier to deal with the inevitable 'I want an Excel file!' requests from clients...
  54. **Brad Montgomery**
  55. I think you nailed the "Python Zen" with tablib.
  56. Thanks again for an awesome lib!
  57. User's Guide
  58. ------------
  59. 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.
  60. .. toctree::
  61. :maxdepth: 2
  62. intro
  63. .. toctree::
  64. :maxdepth: 2
  65. install
  66. .. toctree::
  67. :maxdepth: 2
  68. tutorial
  69. .. toctree::
  70. :maxdepth: 2
  71. development
  72. API Reference
  73. -------------
  74. If you are looking for information on a specific function, class or
  75. method, this part of the documentation is for you.
  76. .. toctree::
  77. :maxdepth: 2
  78. api