Markups-3.0.0/0000755000175000017500000000000013272623365014007 5ustar dmitrydmitry00000000000000Markups-3.0.0/setup.py0000755000175000017500000000315013272620366015521 0ustar dmitrydmitry00000000000000#!/usr/bin/env python3 from setuptools import setup from markups import __version__ as version from os.path import dirname, join with open(join(dirname(__file__), 'README.rst')) as readme_file: long_description = '\n' + readme_file.read() classifiers = [ 'Development Status :: 5 - Production/Stable', 'License :: OSI Approved :: BSD License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Topic :: Text Processing :: Markup', 'Topic :: Text Processing :: General', 'Topic :: Software Development :: Libraries :: Python Modules' ] setup_args = { 'name': 'Markups', 'version': version, 'description': 'A wrapper around various text markups', 'long_description': long_description, 'author': 'Dmitry Shachnev', 'author_email': 'mitya57@gmail.com', 'url': 'https://github.com/retext-project/pymarkups', 'packages': ['markups'], 'install_requires': 'python-markdown-math', 'extras_require': { 'Markdown': ['Markdown>=2.6'], 'reStructuredText': ['docutils'], 'Textile': ['textile'], 'highlighting': ['Pygments'], }, 'entry_points': { 'pymarkups': [ 'markdown = markups.markdown:MarkdownMarkup', 'restructuredtext = markups.restructuredtext:ReStructuredTextMarkup', 'textile = markups.textile:TextileMarkup', ], }, 'license': 'BSD', 'classifiers': classifiers } setup(**setup_args) Markups-3.0.0/changelog0000644000175000017500000001064613272623072015663 0ustar dmitrydmitry00000000000000Version 3.0.0, 2018-05-03 ========================= Incompatible changes: * The deprecated AbstractMarkup API has been removed. * Python 3.2 is no longer supported. * The output now uses HTML5 instead of HTML4. * The custom markups are now registered with entry points. * The ``get_custom_markups()`` method has been removed. * New required dependency: python-markdown-math_. Other changes: * The upcoming Python-Markdown 3.x release is now supported. .. _python-markdown-math: https://pypi.org/project/python-markdown-math/ Version 2.0.1, 2017-06-24 ========================= * The new MathJax CDN is used, the old one will be shut down soon. * When using MathJax with Markdown, the AMSmath and AMSsymbols extensions are now enabled. Version 2.0.0, 2016-05-09 ========================= Incompatible changes: * Changed the API of pymarkups to clearly separate the conversion step from access to the various elements of the result. The old API is deprecated and will be removed in a future release. Please see the documentation for details on using the new API. * The reStructuredText markup now includes document title and subtitle in the HTML body. Other changes: * Added a ``markup2html.py`` reference script to show API usage. * Improved support for specifying Markdown extensions in the document. Version 1.0.1, 2015-12-22 ========================= * The Textile markup now uses the recommended python-textile API. * Fixed warnings during installation. * Python-Markdown Math extension updated to the latest version. Version 1.0, 2015-12-13 ======================= * Web module removed, as ReText no longer needs it. * Textile markup updated to work with the latest version of Python-Textile module. * The setup script now uses setuptools when it is available. * Testsuite and documentation improvements. Version 0.6.3, 2015-06-16 ========================= * No-change re-upload with fixed tarball and changelog. Version 0.6.2, 2015-06-09 ========================= * Markdown markup: fixed detection of codehilite extension with options. * Added a warning about deprecation of the markups.web module. Version 0.6.1, 2015-04-19 ========================= * PyMarkups now uses warnings system instead of printing messages to stderr. * Improvements to Markdown markup: + Fixed parsing math that contains nested environments (thanks to Gautam Iyer for the patch). + Fixed crash on extensions names starting with dot. * Miscellaneous fixes. Version 0.6, 2015-01-25 ======================= Incompatible changes: * Custom markups are now normal Python modules. * Web module no longer supports Python 2.x. Other changes: * Refactor the code related to Markdown extensions to make it work with upcoming Python-Markdown releases. * MathJax extension is now in a separate module. Version 0.5.2, 2014-11-05 ========================= * Fixed loading of Markdown extensions with options. Version 0.5.1, 2014-09-16 ========================= * Fixed Markdown markup crash on empty files. * Include documentation in the tarballs. * Testsuite improvements. Version 0.5, 2014-07-25 ======================= * Improvements to Markdown markup: + All math delimeters except ``$...$`` are now enabled by default. + ``remove_extra`` extension now disables formulas support. + It is now possible to specify required extensions in the first line of the file. * Add Sphinx documentation. Version 0.4, 2013-11-30 ======================= * Add Textile markup. * reStructuredText markup now supports file names and settings overrides. * Web module now raises WebUpdateError when updating fails. Version 0.3, 2013-07-25 ======================= * MathJax support in Markdown has been improved and no longer relies on tex2jax extension. * It is now possible to pass extensions list to MarkdownMarkup constructor. * Pygments style is now configurable. * Testsuite improvements. Version 0.2.3, 2012-11-02 ========================= * Fix support for custom working directory in web module. * Bug fixes in Markdown module and tests. Version 0.2.2, 2012-10-02 ========================= * Re-written math support for Markdown. * Add tests to the tarball. * Add example template for web module. * Bug fixes in Markdown and web modules. Version 0.2.1, 2012-09-09 ========================= * Add caching support, to speed up get_document_body function. * Add testsuite. * Fix some bugs in markdown module. Version 0.2, 2012-09-04 ======================= * Initial release. Markups-3.0.0/.travis.yml0000644000175000017500000000035013272613314016107 0ustar dmitrydmitry00000000000000sudo: false language: python python: - "2.7" - "3.3" - "3.4" - "3.5" - "3.6" - "pypy" - "pypy3" install: pip install Markdown docutils textile pygments codecov script: coverage run setup.py test after_success: codecov Markups-3.0.0/docs/0000755000175000017500000000000013272623365014737 5ustar dmitrydmitry00000000000000Markups-3.0.0/docs/standard_markups.rst0000644000175000017500000000560013272617226021033 0ustar dmitrydmitry00000000000000================ Built-in markups ================ These markups are available by default: Markdown markup =============== Markdown_ markup uses Python-Markdown_ as a backend (version 2.6 is required). There are several ways to enable `Python-Markdown extensions`_. * List extensions in a file named :file:`markdown-extensions.txt` in the :ref:`configuration directory `, separated by newline. The extensions will be automatically applied to all documents. * If :file:`markdown-extensions.txt` is placed into working directory, all documents in that directory will get extensions listed in that file. * If first line of a document contains ":samp:`Required extensions: {ext1 ext2 ...}`", that list will be applied to a document. * Finally, one can programmatically pass list of extension names to :class:`markups.MarkdownMarkup` constructor. The `Math Markdown extension`_ is enabled by default. This extension supports a syntax for LaTeX-style math formulas (powered by MathJax_). The delimiters are: ================ =============== Inline math Standalone math ================ =============== ``$...$`` [#f1]_ ``$$...$$`` ``\(...\)`` ``\[...\]`` ================ =============== .. [#f1] To enable single-dollar-sign delimiter, one should add ``mdx_math(enable_dollar_delimiter=1)`` to the extensions list. The `Python-Markdown Extra`_ set of extensions is enabled by default. To disable it, one can enable virtual ``remove_extra`` extension (which also completely disables LaTeX formulas support). The default file extension associated with Markdown markup is ``.mkd``, though many other extensions (including ``.md`` and ``.markdown``) are supported as well. .. _Markdown: https://daringfireball.net/projects/markdown/ .. _Python-Markdown: https://python-markdown.github.io/ .. _MathJax: https://www.mathjax.org/ .. _`Python-Markdown extensions`: https://python-markdown.github.io/extensions/ .. _`Math Markdown extension`: https://github.com/mitya57/python-markdown-math .. _`Python-Markdown Extra`: https://python-markdown.github.io/extensions/extra/ .. autoclass:: markups.MarkdownMarkup reStructuredText markup ======================== This markup provides support for reStructuredText_ language (the language this documentation is written in). It uses Docutils_ Python module. The file extension associated with reStructuredText markup is ``.rst``. .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Docutils: http://docutils.sourceforge.net/ .. autoclass:: markups.ReStructuredTextMarkup Textile markup ============== This markup provides support for Textile_ language. It uses python-textile_ module. The file extension associated with Textile markup is ``.textile``. .. _Textile: https://en.wikipedia.org/wiki/Textile_(markup_language) .. _python-textile: https://github.com/textile/python-textile .. autoclass:: markups.TextileMarkup Markups-3.0.0/docs/conf.py0000644000175000017500000000306113272620366016234 0ustar dmitrydmitry00000000000000#!/usr/bin/env python3 import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Python-Markups' copyright = u'2018, Dmitry Shachnev' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. from markups import __version_tuple__ # The short X.Y version. version = '%d.%d' % __version_tuple__[:2] # The full version, including alpha/beta/rc tags. release = '%d.%d.%d' % __version_tuple__ # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'nature' Markups-3.0.0/docs/overview.rst0000644000175000017500000000236713272567750017354 0ustar dmitrydmitry00000000000000============ API overview ============ For the basic usage of Python-Markups, one should import some markup class from :mod:`markups`, create an instance of that class, and use the :meth:`~markups.abstract.AbstractMarkup.convert` method: >>> import markups >>> markup = markups.ReStructuredTextMarkup() >>> markup.convert('*reStructuredText* test').get_document_body() '
\n

reStructuredText test

\n
\n' For advanced usage (like dynamically choosing the markup class), one may use one of the functions documented below. Getting lists of available markups ================================== .. autofunction:: markups.get_all_markups .. autofunction:: markups.get_available_markups Getting a specific markup ========================= .. autofunction:: markups.get_markup_for_file_name .. autofunction:: markups.find_markup_class_by_name .. _configuration-directory: Configuration directory ======================= Some markups can provide configuration files that the user may use to change the behavior. These files are stored in a single configuration directory. If :envvar:`XDG_CONFIG_HOME` is defined, then the configuration directory is it. Otherwise, it is :file:`.config` subdirectory in the user's home directory. Markups-3.0.0/docs/custom_markups.rst0000644000175000017500000000447113272571535020554 0ustar dmitrydmitry00000000000000============== Custom Markups ============== Registering the markup module ============================= A third-party markup is a Python module that can be installed the usual way. To register your markup class with PyMarkups, make it inherit from :class:`~markups.abstract.AbstractMarkup`, and add that class to your module's ``entry_points``, in the “pymarkups” entry point group. For example: .. code-block:: python setup( ... entry_points={ 'pymarkups': [ 'mymarkup = mymodule:MyMarkupClass', ], }, ... ) See the `setuptools documentation`_ on entry points for details. To check if the module was found by Python-Markups, one can check if the module is present in return value of :func:`~markups.get_all_markups` function. .. versionchanged:: 3.0 The custom markups should be registered using the entry points mechanism, the ``pymarkups.txt`` file is no longer supported. .. _`setuptools documentation`: https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins Importing third-party modules ============================= A markup must not directly import any third party Python module it uses at file level. Instead, it should check the module availability in :meth:`~markups.abstract.AbstractMarkup.available` static method. That method can try to import the needed modules, and return ``True`` in case of success, and ``False`` in case of failure. Implementing methods ==================== Any markup must inherit from :class:`~markups.abstract.AbstractMarkup`. Third-party markups must implement :class:`~markups.abstract.AbstractMarkup`'s :meth:`~markups.abstract.AbstractMarkup.convert` method, which must perform the time-consuming part of markup conversion and return a newly constructed instance of (a subclass of) :class:`~markups.abstract.ConvertedMarkup`. :class:`~markups.abstract.ConvertedMarkup` encapsulates the title, body, stylesheet and javascript of a converted document. Of these only the body is required during construction, the others default to an empty string. If additional markup-specific state is required to implement :class:`~markups.abstract.ConvertedMarkup`, a subclass can be defined and an instance of it returned from :meth:`~markups.abstract.AbstractMarkup.convert` instead. Markups-3.0.0/docs/index.rst0000644000175000017500000000177313272424404016601 0ustar dmitrydmitry00000000000000=================================== Python-Markups module documentation =================================== Introduction to Python-Markups ============================== Python-Markups is a module that provides unified interface for using various markup languages, such as Markdown, reStructuredText, and Textile. It is also possible for clients to create and register their own markup languages. The output language Python-Markups works with is HTML. Stylesheets and JavaScript sections are supported. The abstract interface that any markup implements is :class:`~markups.abstract.AbstractMarkup`. Contents ======== .. toctree:: overview interface standard_markups custom_markups changelog Links ===== * Python-Markups source code is hosted on GitHub_. * You can get the source tarball from PyPI_. * It is also packaged in Debian_. .. _GitHub: https://github.com/retext-project/pymarkups .. _PyPI: https://pypi.org/project/Markups/ .. _Debian: https://packages.debian.org/sid/source/pymarkups Markups-3.0.0/docs/changelog.rst0000644000175000017500000000050013267434770017417 0ustar dmitrydmitry00000000000000======================== Python-Markups changelog ======================== This changelog only lists the most important changes that happened in Python-Markups. Please see the `Git log`_ for the full list of changes. .. _`Git log`: https://github.com/retext-project/pymarkups/commits/master .. include:: ../changelog Markups-3.0.0/docs/interface.rst0000644000175000017500000000122613267434770017436 0ustar dmitrydmitry00000000000000================ Markup interface ================ The main class for interacting with markups is :class:`~markups.abstract.AbstractMarkup`. However, you shouldn't create direct instances of that class. Instead, use one of the :doc:`standard markup classes `. .. autoclass:: markups.abstract.AbstractMarkup :members: When :class:`~markups.abstract.AbstractMarkup`'s :meth:`~markups.abstract.AbstractMarkup.convert` method is called it will return an instance of :class:`~markups.abstract.ConvertedMarkup` or a subclass thereof that provides access to the conversion results. .. autoclass:: markups.abstract.ConvertedMarkup :members: Markups-3.0.0/markups/0000755000175000017500000000000013272623365015471 5ustar dmitrydmitry00000000000000Markups-3.0.0/markups/markdown.py0000644000175000017500000001347213272620366017672 0ustar dmitrydmitry00000000000000# vim: ts=8:sts=8:sw=8:noexpandtab # This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 from __future__ import absolute_import import importlib import os import re import warnings import markups.common as common from markups.abstract import AbstractMarkup, ConvertedMarkup MATHJAX_CONFIG = \ ''' ''' extensions_re = re.compile(r'required.extensions: (.+)', flags=re.IGNORECASE) extension_name_re = re.compile(r'[a-z0-9_.]+(?:\([^)]+\))?', flags=re.IGNORECASE) _canonicalized_ext_names = {} class MarkdownMarkup(AbstractMarkup): """Markup class for Markdown language. Inherits :class:`~markups.abstract.AbstractMarkup`. :param extensions: list of extension names :type extensions: list """ name = 'Markdown' attributes = { common.LANGUAGE_HOME_PAGE: 'https://daringfireball.net/projects/markdown/', common.MODULE_HOME_PAGE: 'https://github.com/Python-Markdown/markdown', common.SYNTAX_DOCUMENTATION: 'https://daringfireball.net/projects/markdown/syntax' } file_extensions = ('.md', '.mkd', '.mkdn', '.mdwn', '.mdown', '.markdown') default_extension = '.mkd' @staticmethod def available(): try: import markdown except ImportError: return False return (hasattr(markdown, '__version_info__') or # underscored attribute means 3.x hasattr(markdown, 'version_info') and markdown.version_info >= (2, 6)) def _load_extensions_list_from_file(self, filename): try: extensions_file = open(filename) except IOError: return [] else: extensions = [line.rstrip() for line in extensions_file if not line.startswith('#')] extensions_file.close() return extensions def _get_global_extensions(self, filename): extensions = self._load_extensions_list_from_file( os.path.join(common.CONFIGURATION_DIR, 'markdown-extensions.txt')) local_directory = os.path.dirname(filename) if filename else '' extensions += self._load_extensions_list_from_file( os.path.join(local_directory, 'markdown-extensions.txt')) return extensions def _get_document_extensions(self, text): lines = text.splitlines() match = extensions_re.search(lines[0]) if lines else None if match: return extension_name_re.findall(match.group(1)) return [] def _canonicalize_extension_name(self, extension_name): prefixes = ('markdown.extensions.', '', 'mdx_') for prefix in prefixes: try: module = importlib.import_module(prefix + extension_name) if not hasattr(module, 'makeExtension'): continue except (ImportError, ValueError, TypeError): pass else: return prefix + extension_name def _split_extension_config(self, extension_name): """Splits the configuration options from the extension name.""" lb = extension_name.find('(') if lb == -1: return extension_name, {} extension_name, parameters = extension_name[:lb], extension_name[lb + 1:-1] pairs = [x.split("=") for x in parameters.split(",")] return extension_name, {x.strip(): y.strip() for (x, y) in pairs} def _apply_extensions(self): extensions = (self.requested_extensions + self.global_extensions + self.document_extensions) extension_names = {"markdown.extensions.extra", "mdx_math"} extension_configs = {} for extension in extensions: if extension == 'mathjax': mathjax_config = {"enable_dollar_delimiter": True} extension_configs["mdx_math"] = mathjax_config elif extension == 'remove_extra': extension_names.remove("markdown.extensions.extra") extension_names.remove("mdx_math") else: name, config = self._split_extension_config(extension) if name in _canonicalized_ext_names: canonical_name = _canonicalized_ext_names[name] else: canonical_name = self._canonicalize_extension_name(name) if canonical_name is None: warnings.warn('Extension "%s" does not exist.' % extension, ImportWarning) continue _canonicalized_ext_names[name] = canonical_name extension_names.add(canonical_name) extension_configs[canonical_name] = config self.md = self.markdown.Markdown(extensions=list(extension_names), extension_configs=extension_configs, output_format='html5') self.extensions = extension_names def __init__(self, filename=None, extensions=None): AbstractMarkup.__init__(self, filename) import markdown self.markdown = markdown self.requested_extensions = extensions or [] if extensions is None: self.global_extensions = self._get_global_extensions(filename) else: self.global_extensions = [] self.document_extensions = [] self._apply_extensions() def convert(self, text): # Determine body self.md.reset() self.document_extensions = self._get_document_extensions(text) self._apply_extensions() body = self.md.convert(text) + '\n' # Determine title if hasattr(self.md, 'Meta') and 'title' in self.md.Meta: title = str.join(' ', self.md.Meta['title']) else: title = '' # Determine stylesheet if any(extension.endswith('codehilite') for extension in self.extensions): stylesheet = common.get_pygments_stylesheet('.codehilite') else: stylesheet = '' return ConvertedMarkdown(body, title, stylesheet) class ConvertedMarkdown(ConvertedMarkup): def get_javascript(self, webenv=False): if '') else: javascript = '' return javascript Markups-3.0.0/markups/__init__.py0000644000175000017500000000476513272620505017607 0ustar dmitrydmitry00000000000000# This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 import pkg_resources from markups.markdown import MarkdownMarkup from markups.restructuredtext import ReStructuredTextMarkup from markups.textile import TextileMarkup __version_tuple__ = (3, 0, 0) __version__ = '.'.join(map(str, __version_tuple__)) builtin_markups = [MarkdownMarkup, ReStructuredTextMarkup, TextileMarkup] # Public API def get_all_markups(): """ :returns: list of all markups (both standard and custom ones) :rtype: list of markup classes """ entry_points = pkg_resources.iter_entry_points("pymarkups") return [entry_point.load() for entry_point in entry_points] def get_available_markups(): """ :returns: list of all available markups (markups whose :meth:`~markups.abstract.AbstractMarkup.available` method returns True) :rtype: list of markup classes """ available_markups = [] for markup in get_all_markups(): if markup.available(): available_markups.append(markup) return available_markups def get_markup_for_file_name(filename, return_class=False): """ :param filename: name of the file :type filename: str :param return_class: if true, this function will return a class rather than an instance :type return_class: bool :returns: a markup with :attr:`~markups.abstract.AbstractMarkup.file_extensions` attribute containing extension of `filename`, if found, otherwise ``None`` >>> import markups >>> markup = markups.get_markup_for_file_name('foo.mkd') >>> markup.convert('**Test**').get_document_body() '

Test

\\n' >>> markups.get_markup_for_file_name('bar.rst', return_class=True) """ markup_class = None for markup in get_all_markups(): for extension in markup.file_extensions: if filename.endswith(extension): markup_class = markup if return_class: return markup_class if markup_class and markup_class.available(): return markup_class(filename=filename) def find_markup_class_by_name(name): """ :returns: a markup with :attr:`~markups.abstract.AbstractMarkup.name` attribute matching `name`, if found, otherwise ``None`` :rtype: class >>> import markups >>> markups.find_markup_class_by_name('textile') """ for markup in get_all_markups(): if markup.name.lower() == name.lower(): return markup Markups-3.0.0/markups/textile.py0000644000175000017500000000213213272620366017515 0ustar dmitrydmitry00000000000000# vim: ts=8:sts=8:sw=8:noexpandtab # This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2013-2017 from __future__ import absolute_import import markups.common as common from markups.abstract import AbstractMarkup, ConvertedMarkup class TextileMarkup(AbstractMarkup): """Markup class for Textile language. Inherits :class:`~markups.abstract.AbstractMarkup`. """ name = 'Textile' attributes = { common.LANGUAGE_HOME_PAGE: 'http://en.wikipedia.org/wiki/Textile_(markup_language)', common.MODULE_HOME_PAGE: 'https://github.com/textile/python-textile', common.SYNTAX_DOCUMENTATION: 'http://movabletype.org/documentation/author/textile-2-syntax.html' } file_extensions = ('.textile',) default_extension = '.textile' @staticmethod def available(): try: import textile except ImportError: return False return True def __init__(self, filename=None): AbstractMarkup.__init__(self, filename) from textile import textile self.textile = textile def convert(self, text): return ConvertedMarkup(self.textile(text)) Markups-3.0.0/markups/abstract.py0000644000175000017500000000732213272620366017650 0ustar dmitrydmitry00000000000000# vim: ts=8:sts=8:sw=8:noexpandtab # This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 whole_html_template = u""" {custom_headers}{title} {stylesheet}{javascript} {body} """ class AbstractMarkup(object): """Abstract class for markup languages. :param filename: optional name of the file :type filename: str """ #: name of the markup visible to user name = '' #: various attributes, like links to website and syntax documentation attributes = {} #: indicates which file extensions are associated with the markup file_extensions = () #: the default file extension default_extension = '' def __init__(self, filename=None): self.filename = filename @staticmethod def available(): """ :returns: whether the markup is ready for use (for example, whether the required third-party modules are importable) :rtype: bool """ return True def convert(self, text): """ :returns: a ConvertedMarkup instance (or a subclass thereof) containing the markup converted to HTML :rtype: ConvertedMarkup """ raise NotImplementedError class ConvertedMarkup(object): """This class encapsulates the title, body, stylesheet and javascript of a converted document. Instances of this class are created by :meth:`.AbstractMarkup.convert` method, usually it should not be instantiated directly. """ def __init__(self, body, title='', stylesheet='', javascript=''): self.title = title self.stylesheet = stylesheet self.javascript = javascript self.body = body def get_document_title(self): """ :returns: the document title :rtype: str """ return self.title def get_document_body(self): """ :returns: the contents of the ```` HTML tag :rtype: str """ return self.body def get_stylesheet(self): """ :returns: the contents of ``\n' if include_stylesheet else '') context = { "body": self.get_document_body(), "title": self.get_document_title() or fallback_title, "javascript": self.get_javascript(webenv), "stylesheet": stylesheet, "custom_headers": custom_headers, } return whole_html_template.format(**context) Markups-3.0.0/markups/common.py0000644000175000017500000000173113272620366017333 0ustar dmitrydmitry00000000000000# This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 import os.path # Some common constants and functions (LANGUAGE_HOME_PAGE, MODULE_HOME_PAGE, SYNTAX_DOCUMENTATION) = range(3) CONFIGURATION_DIR = (os.getenv('XDG_CONFIG_HOME') or os.getenv('APPDATA') or os.path.expanduser('~/.config')) MATHJAX_LOCAL_URL = 'file:///usr/share/javascript/mathjax/MathJax.js' MATHJAX_WEB_URL = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js' PYGMENTS_STYLE = 'default' def get_pygments_stylesheet(selector, style=None): if style is None: style = PYGMENTS_STYLE if style == '': return '' try: from pygments.formatters import HtmlFormatter except ImportError: return '' else: return HtmlFormatter(style=style).get_style_defs(selector) + '\n' def get_mathjax_url(webenv): if os.path.exists(MATHJAX_LOCAL_URL[7:]) and not webenv: return MATHJAX_LOCAL_URL else: return MATHJAX_WEB_URL Markups-3.0.0/markups/restructuredtext.py0000644000175000017500000000503113272620366021500 0ustar dmitrydmitry00000000000000# vim: ts=8:sts=8:sw=8:noexpandtab # This file is part of python-markups module # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 import markups.common as common from markups.abstract import AbstractMarkup, ConvertedMarkup class ReStructuredTextMarkup(AbstractMarkup): """Markup class for reStructuredText language. Inherits :class:`~markups.abstract.AbstractMarkup`. :param settings_overrides: optional dictionary of overrides for the `Docutils settings`_ :type settings_overrides: dict .. _`Docutils settings`: http://docutils.sourceforge.net/docs/user/config.html """ name = 'reStructuredText' attributes = { common.LANGUAGE_HOME_PAGE: 'http://docutils.sourceforge.net/rst.html', common.MODULE_HOME_PAGE: 'http://docutils.sourceforge.net/', common.SYNTAX_DOCUMENTATION: 'http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html' } file_extensions = ('.rst', '.rest') default_extension = '.rst' @staticmethod def available(): try: import docutils.core except ImportError: return False return True def __init__(self, filename=None, settings_overrides=None): self.overrides = settings_overrides or {} self.overrides.update({ 'math_output': 'MathJax %s?config=TeX-AMS_CHTML' % common.MATHJAX_WEB_URL, 'syntax_highlight': 'short', }) AbstractMarkup.__init__(self, filename) from docutils.core import publish_parts self._publish_parts = publish_parts def convert(self, text): parts = self._publish_parts(text, source_path=self.filename, writer_name='html5', settings_overrides=self.overrides) # Determine head head = parts['head'] # Determine body body = parts['html_body'] # Determine title title = parts['title'] # Determine stylesheet origstyle = parts['stylesheet'] # Cut off tags stylestart = '')] stylesheet += common.get_pygments_stylesheet('.code') return ConvertedReStructuredText(head, body, title, stylesheet) class ConvertedReStructuredText(ConvertedMarkup): def __init__(self, head, body, title, stylesheet): ConvertedMarkup.__init__(self, body, title, stylesheet) self.head = head def get_javascript(self, webenv=False): if 'MathJax.js?config=TeX-AMS_CHTML' not in self.head: return '' return ('\n' % common.get_mathjax_url(webenv)) Markups-3.0.0/README.rst0000644000175000017500000000376313272617473015512 0ustar dmitrydmitry00000000000000.. image:: https://api.travis-ci.org/retext-project/pymarkups.svg :target: https://travis-ci.org/retext-project/pymarkups :alt: Travis CI status .. image:: https://codecov.io/gh/retext-project/pymarkups/branch/master/graph/badge.svg :target: https://codecov.io/gh/retext-project/pymarkups :alt: Coverage status .. image:: https://readthedocs.org/projects/pymarkups/badge/?version=latest :target: https://pymarkups.readthedocs.io/en/latest/ :alt: ReadTheDocs status This module provides a wrapper around various text markup languages. Available by default are Markdown_, reStructuredText_ and Textile_, but you can easily add your own markups. Usage example: .. code:: python >>> import markups >>> markup = markups.get_markup_for_file_name("myfile.rst") >>> markup.name 'reStructuredText' >>> markup.attributes[markups.common.SYNTAX_DOCUMENTATION] 'http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html' >>> text = """ ... Hello, world! ... ============= ... ... This is an example **reStructuredText** document. ... """ >>> result = markup.convert(text) >>> result.get_document_title() 'Hello, world!' >>> print(result.get_document_body()) # doctest: +NORMALIZE_WHITESPACE

Hello, world!

This is an example reStructuredText document.

.. _Markdown: https://daringfireball.net/projects/markdown/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Textile: https://en.wikipedia.org/wiki/Textile_(markup_language) The release version can be downloaded from PyPI_. The source code is hosted on GitHub_. .. _PyPI: https://pypi.org/project/Markups/ .. _GitHub: https://github.com/retext-project/pymarkups The documentation is available online_ or can be generated from source by installing Sphinx_ and running:: python3 setup.py build_sphinx .. _online: https://pymarkups.readthedocs.io/en/latest/ .. _Sphinx: http://www.sphinx-doc.org/en/stable/ Markups-3.0.0/MANIFEST.in0000644000175000017500000000016713267434770015555 0ustar dmitrydmitry00000000000000include LICENSE include README.rst include changelog recursive-include docs *.rst conf.py recursive-include tests *.py Markups-3.0.0/markup2html.py0000755000175000017500000000232613272620366016633 0ustar dmitrydmitry00000000000000#!/usr/bin/env python3 import argparse import markups import sys def export_file(args): markup = markups.get_markup_for_file_name(args.input_file) with open(args.input_file) as input: text = input.read() if not markup: sys.exit('Markup not available.') converted = markup.convert(text) html = converted.get_whole_html(include_stylesheet=args.include_stylesheet, fallback_title=args.fallback_title, webenv=args.web_environment) with open(args.output_file, 'w') as output: output.write(html) if __name__ == '__main__': parser = argparse.ArgumentParser() parser.add_argument('--web-environment', help='export for web environment', action='store_true') parser.add_argument('--include-stylesheet', help='embed the stylesheet into html', action='store_true') parser.add_argument('--fallback-title', help='fallback title of the HTML document', metavar='TITLE') parser.add_argument('input_file', help='input file') parser.add_argument('output_file', help='output file') args = parser.parse_args() export_file(args) Markups-3.0.0/.gitignore0000644000175000017500000000006713267434770016006 0ustar dmitrydmitry00000000000000build dist MANIFEST Markups.egg-info __pycache__ *.pyc Markups-3.0.0/setup.cfg0000644000175000017500000000010313272623365015622 0ustar dmitrydmitry00000000000000[bdist_wheel] universal = 1 [egg_info] tag_build = tag_date = 0 Markups-3.0.0/tests/0000755000175000017500000000000013272623365015151 5ustar dmitrydmitry00000000000000Markups-3.0.0/tests/test_textile.py0000644000175000017500000000073113272620366020237 0ustar dmitrydmitry00000000000000# This file is part of python-markups test suite # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2013-2018 from markups import TextileMarkup import unittest @unittest.skipUnless(TextileMarkup.available(), 'Textile not available') class TextileTest(unittest.TestCase): def test_textile(self): markup = TextileMarkup() html = markup.convert('Hello, **world**!').get_document_body() self.assertEqual(html, '\t

Hello, world!

') Markups-3.0.0/tests/__init__.py0000644000175000017500000000000013272620366017246 0ustar dmitrydmitry00000000000000Markups-3.0.0/tests/test_markdown.py0000644000175000017500000002034413272620366020405 0ustar dmitrydmitry00000000000000# vim: ts=8:sts=8:sw=8:noexpandtab # This file is part of python-markups test suite # License: 3-clause BSD, see LICENSE file # Copyright: (C) Dmitry Shachnev, 2012-2018 from markups.markdown import MarkdownMarkup, _canonicalized_ext_names from os import remove from tempfile import NamedTemporaryFile import unittest import warnings tables_source = \ '''th1 | th2 --- | --- t11 | t21 t12 | t22''' tables_output = \ '''
th1 th2
t11 t21
t12 t22
''' deflists_source = \ '''Apple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. Orange : The fruit of an evergreen tree of the genus Citrus.''' deflists_output = \ '''
Apple
Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
The fruit of an evergreen tree of the genus Citrus.
''' mathjax_header = \ '\n\n' mathjax_source = \ r'''$i_1$ some text \$escaped\$ $i_2$ \(\LaTeX\) \\(escaped\) $$m_1$$ text $$m_2$$ \[m_3\] text \[m_4\] \( \sin \alpha \) text \( \sin \beta \) \[ \alpha \] text \[ \beta \] \$$escaped\$$ \\[escaped\] ''' mathjax_output = \ r'''

some text $escaped$

\(escaped)

text

text

text

text

$$escaped$$ \[escaped]

''' mathjax_multiline_source = \ r''' $$ \TeX \LaTeX $$ ''' mathjax_multiline_output = \ '''

''' mathjax_multilevel_source = \ r''' \begin{equation*} \begin{pmatrix} 1 & 0\\ 0 & 1 \end{pmatrix} \end{equation*} ''' mathjax_multilevel_output = \ r'''

''' @unittest.skipUnless(MarkdownMarkup.available(), 'Markdown not available') class MarkdownTest(unittest.TestCase): maxDiff = None def setUp(self): warnings.simplefilter("ignore", Warning) def test_empty_file(self): markup = MarkdownMarkup() self.assertEqual(markup.convert('').get_document_body(), '\n') def test_extensions_loading(self): markup = MarkdownMarkup() self.assertIsNone(markup._canonicalize_extension_name('nonexistent')) self.assertIsNone(markup._canonicalize_extension_name('nonexistent(someoption)')) self.assertIsNone(markup._canonicalize_extension_name('.foobar')) self.assertEqual(markup._canonicalize_extension_name('meta'), 'markdown.extensions.meta') name, parameters = markup._split_extension_config('toc(anchorlink=1, foo=bar)') self.assertEqual(name, 'toc') self.assertEqual(parameters, {'anchorlink': '1', 'foo': 'bar'}) def test_loading_extensions_by_module_name(self): markup = MarkdownMarkup(extensions=['markdown.extensions.footnotes']) source = ('Footnotes[^1] have a label and the content.\n\n' '[^1]: This is a footnote content.') html = markup.convert(source).get_document_body() self.assertIn('Header\n') self.assertEqual(_canonicalized_ext_names['toc'], 'markdown.extensions.toc') def test_document_extensions_parameters(self): markup = MarkdownMarkup(extensions=[]) toc_header = '\n\n' html = markup.convert(toc_header + '## Header').get_document_body() self.assertEqual(html, toc_header + '\n') toc_header = '\n\n' html = markup.convert(toc_header + '[TOC]\n\n# Header\n[[Link]]').get_document_body() self.assertEqual(html, toc_header + '
Table of contents\n
\n' '\n' '

Link

\n') def test_extra(self): markup = MarkdownMarkup() html = markup.convert(tables_source).get_document_body() self.assertEqual(tables_output, html) html = markup.convert(deflists_source).get_document_body() self.assertEqual(deflists_output, html) def test_remove_extra(self): markup = MarkdownMarkup(extensions=['remove_extra']) html = markup.convert(tables_source).get_document_body() self.assertNotIn('', html) def test_remove_extra_document_extension(self): markup = MarkdownMarkup(extensions=[]) html = markup.convert( 'Required-Extensions: remove_extra\n\n' + tables_source).get_document_body() self.assertNotIn('
', html) def test_remove_extra_removes_mathjax(self): markup = MarkdownMarkup(extensions=['remove_extra']) html = markup.convert('$$1$$').get_document_body() self.assertNotIn('math/tex', html) def test_meta(self): markup = MarkdownMarkup() text = ('Required-Extensions: meta\n' 'Title: Hello, world!\n\n' 'Some text here.') title = markup.convert(text).get_document_title() self.assertEqual('Hello, world!', title) def test_default_math(self): # by default $...$ delimeter should be disabled markup = MarkdownMarkup(extensions=[]) self.assertEqual('

$1$

\n', markup.convert('$1$').get_document_body()) self.assertEqual('

\n\n

\n', markup.convert('$$1$$').get_document_body()) def test_mathjax(self): markup = MarkdownMarkup(extensions=['mathjax']) # Escaping should work self.assertEqual('', markup.convert('Hello, \\$2+2$!').get_javascript()) js = markup.convert(mathjax_source).get_javascript() self.assertIn('', body) self.assertIn('