跳转到主要内容

告别你的维基百科!使用pandoc将MediaWiki页面转换为其他格式的Python命令行脚本

项目描述

bye_wiki (bw)

License: BSD 3-Clause License

告别你的维基百科!使用pandoc将MediaWiki页面转换为其他格式的Python命令行封装器

关于

bye_wiki (bw) 是一个Python命令行脚本,用于将MediaWiki页面转换为其他格式,如AsciiDoc和Markdown。

这使得将文档和维基页面从MediaWiki服务器迁移到其他地方变得更加容易。无论“其他地方”对你来说意味着什么,这个工具都提供了基本的转换,以便您可以使用新格式中的信息。bye_wiki基本上是一个包装了requestspandoc的华丽封装器。

如何使用

注意:您必须已经在本系统上安装了pandoc,此脚本才能正常工作!

一旦您有了pandoc,开始使用bye_wiki的最简单方法是将其从PyPI安装

pip install --user bye-wiki

CLI --help 菜单提供了关于如何使用bye_wiki的更详细的信息。以下是一些示例

示例 1

将Wikipedia页面El Ten Eleven转换为Markdown文档。

bw --title "El Ten Eleven" --out ~/ete.md

示例 2

Fedora项目的MediaWiki中的Fedora_Linux_38_Release_Party_Schedule转换为AsciiDoc文档。

bw --url fedoraproject.org/w --format asciidoc --title "Fedora_Linux_38_Release_Party_Schedule" --out licensing.adoc

示例 3

MusicBrainz的MediaWiki中的MusicBrainz原则转换为Markdown文档,排除从pandoc命令中的--markdown-headings=atx标志

bw --url wiki.musicbrainz.org --title MusicBrainz_Principles --out mb-principles.md --atx-off

提示:如果您不确定是否需要 --atx-off,那么您不需要。ATX 是 Markdown 文档更受欢迎的格式,但一些作者可能更喜欢不使用 ATX 样式的标题。

如何贡献

请参阅 CONTRIBUTING.md

法律

许可协议为 BSD 3-Clause License

项目详情


下载文件

下载适合您平台文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分布

bye_wiki-0.1.0.tar.gz (4.9 kB 查看哈希值)

上传时间

构建分布

bye_wiki-0.1.0-py3-none-any.whl (5.2 kB 查看哈希值)

上传时间 Python 3