Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/msabramo/pydocverter

Python client for Docverter service (pandoc as a service)
https://github.com/msabramo/pydocverter

Last synced: 28 days ago
JSON representation

Python client for Docverter service (pandoc as a service)

Awesome Lists containing this project

README

        

pydocverter
===========

Python client for Docverter_ service

.. image:: https://pypip.in/version/pydocverter/badge.svg?style=flat
:target: https://pypi.python.org/pypi/pydocverter/
:alt: Latest Version

.. image:: https://travis-ci.org/msabramo/pydocverter.svg?branch=master
:target: https://travis-ci.org/msabramo/pydocverter

Docverter_ is a hosted service
that can do convert documents from one format to another (using pandoc_).
For example, it can be used to convert Markdown_ documents to reStructuredText_.
This is very useful if you prefer to write your ``README`` in Markdown,
but want to publish your package to PyPI,
which only knows how to do nice rendering of descriptions
written in reStructuredText.

This module is a Python client to the Docverter service.

It has a very similar API to that of pypandoc_, so that you can do stuff like:

.. code-block:: python

try:
import pypandoc as converter
except ImportError:
import pydocverter as converter

converter.convert('somefile.md', 'rst')

Similar
==================

https://github.com/lukedmor/ghmarkdown

.. _Docverter: http://www.docverter.com/
.. _pandoc: http://johnmacfarlane.net/pandoc
.. _Markdown: http://daringfireball.net/projects/markdown/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _pypandoc: https://github.com/bebraw/pypandoc