bye_wiki (bw)
=============
[![License: BSD 3-Clause License][1]][2]
Say goodbye to your wikis!
Python command-line wrapper to convert MediaWiki pages to other formats with `pandoc`
## About
bye_wiki (`bw`) is a Python command-line script to convert MediaWiki pages into other formats like AsciiDoc and Markdown.
This makes it easier to migrate documentation and wiki pages from a MediaWiki server to somewhere else.
Regardless of whatever "somewhere else" means for you, this tool provides a basic conversion for you to work with the information from a new format.
bye_wiki is more or less a fancy wrapper for `requests` and `pandoc`.
## How to use
**NOTE**:
You must already have [pandoc][3] 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:
```sh
pip 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.
```sh
bw --title "El Ten Eleven" --out ~/ete.md
```
### Example 2
Convert _Fedora_Linux_38_Release_Party_Schedule_ from the [Fedora Project][4] MediaWiki to an AsciiDoc document.
```sh
bw --url fedoraproject.org/w --format asciidoc --title "Fedora_Linux_38_Release_Party_Schedule" --out licensing.adoc
```
### Example 3
Convert _MusicBrainz Principles_ from the [MusicBrainz][5] MediaWiki to a Markdown document, with the `--markdown-headings=atx` flag excluded from the `pandoc` command:
```sh
bw --url wiki.musicbrainz.org --title MusicBrainz_Principles --out mb-principles.md --atx-off
```
_Hint_:
If you are not sure whether you want `--atx-off` or not, you do not.
ATX is the more popular format for Markdown documents, but some writers may prefer to not have ATX-style headers.
## How to contribute
See [CONTRIBUTING.md][6].
## Legal
Licensed under [BSD 3-Clause License][2].
[1]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
[2]: https://opensource.org/licenses/BSD-3-Clause "BSD-3-Clause License - opensource.org"
[3]: https://pandoc.org/
[4]: https://getfedora.org
[5]: https://musicbrainz.org
[6]: https://github.com/jwflory/bw/blob/main/.github/CONTRIBUTING.md "How to contribute to the project"
Raw data
{
"_id": null,
"home_page": "https://github.com/jwflory/bw",
"name": "bye-wiki",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "asciidoc,data,wiki,mediawiki,markdown,documentation,migration,pandoc",
"author": "Justin W. Flory",
"author_email": "contact@jwf.io",
"download_url": "https://files.pythonhosted.org/packages/d3/1b/de2997f629e7250a6fb60d084f2efcddecdf3b509976d7701c4e3f2a093c/bye_wiki-0.1.0.tar.gz",
"platform": null,
"description": "bye_wiki (bw)\n=============\n\n[![License: BSD 3-Clause License][1]][2]\n\nSay goodbye to your wikis!\nPython command-line wrapper to convert MediaWiki pages to other formats with `pandoc`\n\n\n## About\n\nbye_wiki (`bw`) is a Python command-line script to convert MediaWiki pages into other formats like AsciiDoc and Markdown.\n\nThis makes it easier to migrate documentation and wiki pages from a MediaWiki server to somewhere else.\nRegardless of whatever \"somewhere else\" means for you, this tool provides a basic conversion for you to work with the information from a new format.\nbye_wiki is more or less a fancy wrapper for `requests` and `pandoc`.\n\n\n## How to use\n\n**NOTE**:\nYou must already have [pandoc][3] installed on your system for this script to work!\n\nOnce you have `pandoc`, the easiest way to get started with bye_wiki is to install from PyPI:\n\n```sh\npip install --user bye-wiki\n```\n\nThe CLI `--help` menu provides more detailed information about how to use bye_wiki.\nSome examples are below:\n\n### Example 1\n\nConvert _El Ten Eleven_ Wikipedia page to a Markdown document.\n\n```sh\nbw --title \"El Ten Eleven\" --out ~/ete.md\n```\n\n### Example 2\n\nConvert _Fedora_Linux_38_Release_Party_Schedule_ from the [Fedora Project][4] MediaWiki to an AsciiDoc document.\n\n```sh\nbw --url fedoraproject.org/w --format asciidoc --title \"Fedora_Linux_38_Release_Party_Schedule\" --out licensing.adoc\n```\n\n### Example 3\n\nConvert _MusicBrainz Principles_ from the [MusicBrainz][5] MediaWiki to a Markdown document, with the `--markdown-headings=atx` flag excluded from the `pandoc` command:\n\n```sh\nbw --url wiki.musicbrainz.org --title MusicBrainz_Principles --out mb-principles.md --atx-off\n```\n\n_Hint_:\nIf you are not sure whether you want `--atx-off` or not, you do not.\nATX is the more popular format for Markdown documents, but some writers may prefer to not have ATX-style headers.\n\n\n## How to contribute\n\nSee [CONTRIBUTING.md][6].\n\n\n## Legal\n\nLicensed under [BSD 3-Clause License][2].\n\n[1]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\n[2]: https://opensource.org/licenses/BSD-3-Clause \"BSD-3-Clause License - opensource.org\"\n[3]: https://pandoc.org/\n[4]: https://getfedora.org\n[5]: https://musicbrainz.org\n[6]: https://github.com/jwflory/bw/blob/main/.github/CONTRIBUTING.md \"How to contribute to the project\"\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Say goodbye to your wikis! Python command-line script to convert MediaWiki pages to other formats with pandoc",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jwflory/bw"
},
"split_keywords": [
"asciidoc",
"data",
"wiki",
"mediawiki",
"markdown",
"documentation",
"migration",
"pandoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df7349b17e279b27894330f3dd8d9a57da2ecaa3d6abee02e612a8ac3cabb185",
"md5": "2aacb0a62e7ce17ac21ead4a499b06a4",
"sha256": "8fdeacfd4b4c679679d64f42f07577bdf2cd8caaa5d169836b1b15edf674b92f"
},
"downloads": -1,
"filename": "bye_wiki-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2aacb0a62e7ce17ac21ead4a499b06a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 5193,
"upload_time": "2023-06-22T14:42:56",
"upload_time_iso_8601": "2023-06-22T14:42:56.223703Z",
"url": "https://files.pythonhosted.org/packages/df/73/49b17e279b27894330f3dd8d9a57da2ecaa3d6abee02e612a8ac3cabb185/bye_wiki-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d31bde2997f629e7250a6fb60d084f2efcddecdf3b509976d7701c4e3f2a093c",
"md5": "be90292de8899ddf89eed690a4151a2e",
"sha256": "4785e73f6269014bfcfd022e35f65d51760059feeaf7eb69bd00e02737a11dd4"
},
"downloads": -1,
"filename": "bye_wiki-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "be90292de8899ddf89eed690a4151a2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 4892,
"upload_time": "2023-06-22T14:42:57",
"upload_time_iso_8601": "2023-06-22T14:42:57.613473Z",
"url": "https://files.pythonhosted.org/packages/d3/1b/de2997f629e7250a6fb60d084f2efcddecdf3b509976d7701c4e3f2a093c/bye_wiki-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-22 14:42:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jwflory",
"github_project": "bw",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bye-wiki"
}
JSON
