Say goodbye to your wikis! Python command-line script to convert MediaWiki pages to other formats with pandoc
Project description
bye_wiki (bw)
Say goodbye to your wikis! Python command-line tool to convert MediaWiki pages to Markdown with pandoc
About
bye_wiki (bw
) is a Python command-line script to convert MediaWiki pages into Markdown.
This makes migrating documentation and pages from a MediaWiki server to somewhere else.
Regardless of whatever "somewhere else" means for you, this tool provides a basic Markdown conversion for you to work with in a new platform.
bye_wiki is more or less a fancy wrapper for requests
and pandoc
.
How to use
NOTE: You must already have pandoc installed on your system for this script to work!
Once you have pandoc
, the easiest way to get started with bye_wiki is to install from PyPI:
pip3 install --user bye-wiki
The CLI --help
menu provides more detailed information about how to use bye_wiki.
Some examples are below:
Example 1
Convert El Ten Eleven Wikipedia page to a Markdown document.
bw --title "El Ten Eleven" --out ~/ete.md
Example 2
Convert Licensing:Main from the Fedora Project MediaWiki to a Markdown document.
bw --url fedoraproject.org/w --title "Licensing:Main" --out licensing.md
Example 3
Convert MusicBrainz Principles from the MusicBrainz MediaWiki to a Markdown document, with the --atx
flag removed from pandoc
:
bw --url wiki.musicbrainz.org --title MusicBrainz_Principles --out mb-principles.md --atx-off
Hint:
If you aren't sure if you want --atx-off
or not, you do not.
It is an opinionated format for converting documents but some writers may prefer to not have ATX-style headers.
How to contribute
See CONTRIBUTING.md.
Legal
Licensed under BSD 3-Clause License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.