{"id":16325538,"url":"https://github.com/jwflory/bw","last_synced_at":"2025-03-22T21:32:57.717Z","repository":{"id":44787707,"uuid":"211571559","full_name":"jwflory/bw","owner":"jwflory","description":"(bw == \"Bye Wiki\") Say goodbye to your wikis! Python command-line tool to convert MediaWiki pages to other formats with pandoc","archived":false,"fork":false,"pushed_at":"2023-10-17T20:37:51.000Z","size":62,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T15:16:42.928Z","etag":null,"topics":["asciid","asciidoc","asciidoctor","cli","command-line","command-line-tool","documentation-tool","markdown","mediawiki","mediawiki-wikis","pandoc","python","python3","wiki","wikis"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwflory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-28T23:01:24.000Z","updated_at":"2023-08-14T01:50:04.000Z","dependencies_parsed_at":"2024-10-28T15:35:52.241Z","dependency_job_id":null,"html_url":"https://github.com/jwflory/bw","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.2272727272727273,"last_synced_commit":"4a0980c2ca92f9f5a11934b8882f31d3aaaf8151"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwflory%2Fbw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwflory%2Fbw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwflory%2Fbw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwflory%2Fbw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwflory","download_url":"https://codeload.github.com/jwflory/bw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245023556,"owners_count":20548744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciid","asciidoc","asciidoctor","cli","command-line","command-line-tool","documentation-tool","markdown","mediawiki","mediawiki-wikis","pandoc","python","python3","wiki","wikis"],"created_at":"2024-10-10T23:05:16.964Z","updated_at":"2025-03-22T21:32:57.420Z","avatar_url":"https://github.com/jwflory.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwflory%2Fbw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwflory%2Fbw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwflory%2Fbw/lists"}