Skip to main content

bookstack-dl

Python module to help automatically export all pages in a bookstack instances. This will crawl through the web api, listing all books, chapters, and pages. Then, it will download them in a folder heirarchy.

Installation

pip install bookstack_dl

Usage

from bookstack_dl import BookstackAPI

# Initiate and log in.
bs = BookstackAPI("https://your.bookstackinstall.com", "user@email.com", "userpassword")

# kick off gathering meta data
bs.get_all_books()

# download all
bs.download_all("<full_path_to_root_download_dir>")

Python Dependencies

Currently, this requires Python 3.6+ due to the use of f-strings. The os.makedirs exist_ok option requires 3.5+. Contributions are welcome to help lower the minimum required version.

Metadata

Release files for bookstack-dl 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bookstack-dl 0.1.1
File Size Uploaded
bookstack_dl-0.1.1.tar.gz 4.4 kB Details

Release files / bookstack_dl-0.1.1.tar.gz

Download URL bookstack_dl-0.1.1.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
04e53be57c906ed4bcf84227b68278644e15afe29e496afe09c1d2690d195f49
BLAKE2b-256 checksum
How to use checksums
cfe748dc3e5721a0c1a93c861e188426ba76f77ec4c05d000a6f66255602001a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page