title='xxx'defexport_set(dset):....# returns string representation of given datasetdefexport_book(dbook):....# returns string representation of given databookdefimport_set(dset,in_stream):...# populates given Dataset with given datastreamdefimport_book(dbook,in_stream):...# returns Databook instancedefdetect(stream):...# returns True if given stream is parsable as xxx

Excluding Support

If the format excludes support for an import/export mechanism (eg.csv excludes Databook support), simply don’t define the respective functions. Appropriate errors will be raised.

Testing is crucial to Tablib’s stability. This stable project is used in production by many companies and developers, so it is important to be certain that every version released is fully operational. When developing a new feature for Tablib, be sure to write proper tests for it as well.

When developing a feature for Tablib, the easiest way to test your changes for potential issues is to simply run the test suite directly.

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.

Documentation is written in the powerful, flexible, and standard Python documentation format, reStructured Text.
Documentation builds are powered by the powerful Pocoo project, Sphinx. The API Documentation is mostly documented inline throughout the module.

The Docs live in tablib/docs. In order to build them, you will first need to install Sphinx.

$ pip install sphinx

Then, to build an HTML version of the docs, simply run the following from the docs directory:

$ make html

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.