Metadata-Version: 1.1
Name: mwtemplates
Version: 0.3.2
Summary: MediaWiki template parser and editor
Home-page: https://github.com/danmichaelo/mwtemplates
Author: Dan Michael Heggø
Author-email: danmichaelo@gmail.com
License: MIT
Description: mwtemplates
        ==================
        
        .. image:: http://img.shields.io/travis/danmichaelo/mwtemplates.svg?style=flat
           :target: https://travis-ci.org/danmichaelo/mwtemplates
           :alt: Build status
        
        .. image:: http://img.shields.io/coveralls/danmichaelo/mwtemplates.svg?style=flat
           :target: https://coveralls.io/r/danmichaelo/mwtemplates
           :alt: Test coverage
        
        .. image:: https://pypip.in/version/mwtemplates/badge.svg?style=flat
           :target: https://pypi.python.org/pypi/mwtemplates/
           :alt: Latest Version
        
        .. image:: https://pypip.in/py_versions/mwtemplates/badge.svg?style=flat
           :target: https://pypi.python.org/pypi/mwtemplates/
           :alt: Supported Python versions
        
        .. image:: https://pypip.in/download/mwtemplates/badge.svg?period=month&style=flat
           :target: https://pypi.python.org/pypi/mwtemplates/
           :alt: Downloads
        
        mwtemplates is a simple MediaWiki wikitext template parser and editor, based on a Python rewrite of the MediaWiki preprocessorDOM.php.
        Tested with python 2.6, 2.7, 3.2, 3.3 and 3.4.
        
        
        Installation
        -------------------
        
        The package is on PyPI, so you can install it using `pip`, `easy_install` or similar:
        
        .. code-block:: console
        
           $ pip install mwtemplates
        
        
        Running tests
        -------------------
        
        To run tests, clone the repo and do:
        
        .. code-block:: console
            
            $ pip install -r requirements.txt
            $ pip install -r test_requirements.txt
            $ py.test -x tests --pep8 mwtemplates -v --cov mwtemplates --doctest-modules
        
        Usage examples
        -------------------
        
        Editing a template:
        
        .. code-block:: python
        
            from mwtemplates import TemplateEditor
            txt = u"""
            {{Infoboks geografi
            | kart = Svalbard_kart1.png
            | land = Norge
            | status = Øygruppe
            | administrasjon = [[Odd Olsen Ingerø]] ''<small>(2009)</small>''
            | administrasjonsnavn = [[Sysselmannen på Svalbard|Sysselmann]]
            | areal = 61022
            | befolkning = 2527
            | befolkningsår = [[2011]]
            | url = www.sysselmannen.svalbard.no
            }}
            """
            te = TemplateEditor(txt)
            te.templates['infoboks geografi'][0].parameters['land'] = 'Russland'
            print te.wikitext()
        
        Updating a page on Wikipedia using `mwclient <https://github.com/mwclient/mwclient>`_
        
        .. code-block:: python
        
           from mwclient import Site
           from mwtemplates import TemplateEditor
        
           site = Site('en.wikipedia.org')
           site.login('USERNAME', 'PASSWORD')
           page = site.pages['SOME_PAGE']
           te = TemplateEditor(page.edit())
           if 'SOME_TEMPLATE' in page.templates:
              tpl = te.templates['SOME_TEMPLATE'][0]
              tpl.parameters['test'] = 'Hello'
           page.save(te.wikitext(), summary='...')
        
        Removing a template argument:
        
        .. code-block:: python
        
            from mwtemplates import TemplateEditor
            te = TemplateEditor(u"Hello {{mytpl | a=2 | b=3 | c=4 }} world")
            te.templates['mytpl'].parameters.remove('b')
        
        Removing the first instance of a template:
        
        .. code-block:: python
        
            from mwtemplates import TemplateEditor
            te = TemplateEditor(u"Hello {{mytpl}} world {{mytpl}}")
            te.templates['mytpl'][0].remove()
        
        
Keywords: mediawiki wikipedia
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
