pyembed-markdown 1.1.0

PyEmbed-Markdown
===============

.. image:: https://secure.travis-ci.org/pyembed/pyembed-markdown.png?branch=master
:target: http://travis-ci.org/pyembed/pyembed-markdown
.. image:: https://coveralls.io/repos/pyembed/pyembed-markdown/badge.png
:target: https://coveralls.io/r/pyembed/pyembed-markdown
.. image:: https://pypip.in/d/pyembed-markdown/badge.png
:target: https://pypi.python.org/pypi/pyembed-markdown/
.. image:: https://pypip.in/v/pyembed-markdown/badge.png
:target: https://pypi.python.org/pypi/pyembed-markdown/
.. image:: https://pypip.in/wheel/pyembed-markdown/badge.png
:target: https://pypi.python.org/pypi/pyembed-markdown/
.. image:: https://pypip.in/egg/pyembed-markdown/badge.png
:target: https://pypi.python.org/pypi/pyembed-markdown/
.. image:: https://pypip.in/license/pyembed-markdown/badge.png
:target: https://pypi.python.org/pypi/pyembed-markdown/

Python Markdown extension for embedding content using `OEmbed`_.

PyEmbed-Markdown allows you to embed content in your Markdown websites and
documents from a wide range of producers. You don't need to configure
anything - the extension automatically discovers how to embed content.

Usage
-----

Initialize the extension like this:

::

md = markdown.Markdown(extensions=[PyEmbedMarkdown()])

You can then embed content by entering a link with the special text `!embed`,
like this:

::

[!embed](http://www.youtube.com/watch?v=9bZkp7q19f0)

This will be turned into the following HTML:

::

<iframe width="480" height="270" src="http://www.youtube.com/embed/9bZkp7q19f0?feature=oembed" frameborder="0" allowfullscreen></iframe>

For more information, see the `PyEmbed`_ website.

Compatibility
-------------

PyEmbed-Markdown has been tested with Python 2.7, 3.3 and 3.4.

Installation
------------

PyEmbed-Markdown can be installed using pip:

::

pip install pyembed-markdown

Contributing
------------

To report an issue, request an enhancement, or contribute a patch, go to
the PyEmbed-Markdown `GitHub`_ page.

License
-------

PyEmbed-Markdown is distributed under the MIT license.

::

Copyright (c) 2013 Matt Thomson

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.. _OEmbed: http://oembed.com
.. _PyEmbed: http://pyembed.github.io
.. _GitHub: https://github.com/pyembed/pyembed-markdown

.. :changelog:

Changes
=======

v1.1.0, 2014-08-02
------------------

Upgrade to PyEmbed v1.1.0.

v1.0.0, 2014-02-05
------------------

Initial stable release

v0.7.1, 2014-01-20
------------------

Breaking changes:

- The class ``PyEmbedMarkdown`` has been moved to the ``pyembed.markdown``
package.

v0.7.0, 2014-01-20
------------------

Breaking changes:

- The class ``PyEmbedExtension`` has been renamed to ``PyEmbedMarkdown``.

v0.6.0, 2014-01-01
------------------

Enhancements:

- #15: Use pluggable renderer

v0.5.0, 2014-01-01
------------------

Breaking changes:

- The ``rembed`` package has been renamed to ``pyembed``.

Enhancements:

- #12: Rename to PyEmbed

v0.2.0, 2013-12-29
------------------

Enhancements:

- #5: Allow specifying maximum height / width
- #6: Allow use of custom templates

v0.1.3, 2013-10-26
------------------

Bug fixes:

- #4: Bad HTML tags in output

v0.1.2, 2013-08-09
------------------

Documentation fix

v0.1.1, 2013-08-09
------------------

Fix PyPI packaging problem

v0.1.0, 2013-08-09
------------------

Initial release