Migcon: Migrate Confluence Export to Jupyter Book
This utility assists in converting Confluence content to a Jupyter Book project. Specifically, once you have a Confluence HTML export that has been converted to Markdown, run this utility against the converted source to move documents into a directory structure that mirrors the confluence page hierarchy as well as generating the Jupyter Book-isms necessary to correctly publish back to confluence.
To run:
./con2jupyterbook -i <source-dr> -o <target-dir>
Notes
When exporting from confluence, an index.md file is generated that holds the exported page hierarchy in a
nested list. This utility relies on that format, so the index.md file should not be edited prior to running
this utility.
What it does...
The HTML export from Confluence dumps the whole tree into a single directory. The con2jb will create a directory tree to mirror the page hierarchy from confluence and do some requisite fixup automatically. Additionally, it will generate the jupyter book table of contents to ensure that the correct page hierarchy is restored upon publication.
There are several other miscellaneous fixes that are performed including: referencing attachment and image links from the root rather than the current directory and removal of some sections that are added to a given page that are not present in the Confluence page source, e.g. Comments, Attachment Lists, Change History.
Step-by-Step Instructions
- Prerequisites: Node.js installed, Python installed
- Use Confluence to export all or a part of your wiki via HTML. (Export Content...)
- Create a working directory and unzip the Confluence export into that directory (sub-dir html)
- Clone Confluence to Markdown
- From within the cloned directory run
npm run start <working-dir>/html <working-dir>/markdown pip install migcon- Run con2jb to convert the exported markdown into a MyST, sphinx friendly markdown/dir structure
con2jb -i <working-dir>/markdown -o <working-dir>/sphinx - Copy the resultant jupyter book friendly markdown into the project of your choice
- Use jupyter book to build your desired output. Note: this will result in a few warnings that need to be addressed.
1 maintainer
Metadata
1 maintainer
Release files for migcon 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| migcon-1.2.2-py3-none-any.whl | Python 3 | none | any | Details for migcon-1.2.2-py3-none-any.whl |
Release files / migcon-1.2.2-py3-none-any.whl
| Download URL | migcon-1.2.2-py3-none-any.whl |
|---|---|
| Size | 22.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1ef1b88d88301f02d2819e3c141eb5bb6417a29ec55dd8de6309a34ee5535dee
|
|
BLAKE2b-256 checksum How to use checksums |
16d5cf965922a4bea21203bd3f069aa0751cd7159d285866dc5668e4d4511dd7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.0
|
Security for migcon 1.2.2
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.
