bye_wiki (bw)
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 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:
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.
bw --title "El Ten Eleven" --out ~/ete.md
Example 2
Convert Fedora_Linux_38_Release_Party_Schedule from the Fedora Project MediaWiki to an AsciiDoc document.
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 MediaWiki to a Markdown document, with the --markdown-headings=atx flag excluded from the pandoc command:
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.
Legal
Licensed under BSD 3-Clause License.
Metadata
Release files for bye-wiki 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bye_wiki-0.1.0.tar.gz | 4.9 kB | Without provenance | Details for bye_wiki-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bye_wiki-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for bye_wiki-0.1.0-py3-none-any.whl |
Total release size: 10.1 kB
Release files / bye_wiki-0.1.0.tar.gz
| Download URL | bye_wiki-0.1.0.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4785e73f6269014bfcfd022e35f65d51760059feeaf7eb69bd00e02737a11dd4
|
|
BLAKE2b-256 checksum How to use checksums |
d31bde2997f629e7250a6fb60d084f2efcddecdf3b509976d7701c4e3f2a093c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / bye_wiki-0.1.0-py3-none-any.whl
| Download URL | bye_wiki-0.1.0-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8fdeacfd4b4c679679d64f42f07577bdf2cd8caaa5d169836b1b15edf674b92f
|
|
BLAKE2b-256 checksum How to use checksums |
df7349b17e279b27894330f3dd8d9a57da2ecaa3d6abee02e612a8ac3cabb185
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Security for bye-wiki 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.