makinacorpus/convertit repository overview

Convertit is a format conversion webservice.

Retrieve your document in an other format ! The input file is converted and served back ! Using a dead simple GET request, documents are pulled. Using POST request, it takes the attachment.

.. image:: https://api.travis-ci.org/makinacorpus/convertit.png⁠ :target: https://travis-ci.org/makinacorpus/convertit⁠

Supported conversions:

• odt -> pdf
• odt -> doc
• ods -> xls
• csv -> ods
• csv -> xls
• svg -> pdf
• svg -> png

Previously converted documents are cleaned along the way (on each request).

⁠===== USAGE

⁠Using GET request

Example, convert from odt to pdf :

::

curl http://convertit/?url=http://server/document.odt&to=application/pdf
HTTP/1.1 302 Found
Content-Disposition: attachement; filename=document.pdf
...

GET parameters:

url: absolute url of the document to be converted.

"url" also supports a "{X_FORWARDED_FOR}" placeholder for requests not knowing their own host. "{X_FORWARDED_FOR}" will be replaced with the corresponding "X_FORWARDED_FOR" header if available. Be warned that "X_FORWARDED_FOR" is not a safe value since it can be modified by user agents or given false value by forward proxies. Use only if really needed. Exemple::

curl "http://convertit/?url=http://{X_FORWARDED_FOR}/document.odt&to=application/pdf⁠"

⁠Using POST request

Upload data in POST parameter named file:

::

curl -F "[email protected]" http://convertit/?to=image/png
HTTP/1.1 302 Found
Content-Disposition: attachement; filename=tiger.png

⁠Query parameters

• to: output mimetype (optionnal, default to application/pdf if not provided);
• from: input mimetype (optionnal, guessed from input url or file if not provided).

⁠======= INSTALL

⁠System dependencies

• for OpenDocument support: unoconv
• for SVG support: inkscape

Conversion binaries should be in system PATH (which is used internally.)

⁠Download

• Download and extract a released tarball from pypi <http://pypi.python.org/pypi/convertit>_

• The bleeding edge version is hosted on github <https://github.com/makinacorpus/convertit>_ ::

  git clone https://github.com/makinacorpus/convertit.git⁠ cd convertit

⁠Development

::

make serve

Once the application is running, you may visit http://localhost:6543/⁠ in your browser.

Run tests: ::

make tests

⁠Production

Using gunicorn for example :

::

gunicorn --workers=1 --paste=production.ini

Using Docker :

::

sudo docker build -t="convertit" .
sudo docker run -p :6543 convertit

⁠Feedback

Open an issue <https://github.com/makinacorpus/convertit/issues>_ to report a bug or request a new feature.

⁠======= CREDITS

⁠Companies

|makinacom|_

• Planet Makina Corpus <http://www.makina-corpus.org>_
• Contact us <mailto:[email protected]>_

.. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif⁠ .. _makinacom: http://www.makina-corpus.com⁠

⁠Authors

• Antoine Cezar
• Alex Marandon

⁠Contributors

• kiorky [email protected]⁠
• Mathieu Leplatre [email protected]⁠
• Gaël Utard [email protected]⁠
• Jean-Etienne Castagnede [email protected]⁠