Skip to content

Commit

Permalink
Add a bunch more files for packaging.
Browse files Browse the repository at this point in the history
  • Loading branch information
clokep committed Mar 28, 2018
1 parent 5024f2b commit 97f77eb
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
0.1
===

* Basic support for converting parsed MediaWiki wikicode to HTML.
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include LICENSE
include CHANGELOG.rst
include README.rst
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
mwcomposerfromhell
##################

**mwcomposerfromhell** is a Python package that provides an easy-to-use composer
to convert the MediaWiki wikicode to HTML via `mwparserfromhell`_. It supports
Python 3.

.. _mwparserfromhell: https://github.com/earwig/mwparserfromhell/

Usage
-----

Normal usage is rather straightforward (where ``text`` is page text)::

>>> import mwparserfromhell
>>> import mwcomposerfromhell
>>> wikicode = mwparserfromhell.parse(text)
>>> html = mwcomposerfromhell.compose(wikicode)

``html`` is a ``str`` object for the output HTML.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ def long_description():
name='mwcomposerfromhell',
version="0.1",
packages=find_packages(),
description='',
description='Convert the parsed MediaWiki wikicode (using mwparserfromhell) to HTML.',
long_description=long_description(),
author='Patrick Cloke',
author_email='[email protected]',
classifiers=[
'Development Status :: 4 - Beta',
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: Internet',
Expand Down

0 comments on commit 97f77eb

Please sign in to comment.