Skip to main content

Automatically export all pages in Bookstack.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bookstack_dl-0.1.1.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file bookstack_dl-0.1.1.tar.gz.

File metadata

  • Download URL: bookstack_dl-0.1.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for bookstack_dl-0.1.1.tar.gz
Algorithm Hash digest
SHA256 04e53be57c906ed4bcf84227b68278644e15afe29e496afe09c1d2690d195f49
MD5 0e6ed0327954a087199dbb5ac737f419
BLAKE2b-256 cfe748dc3e5721a0c1a93c861e188426ba76f77ec4c05d000a6f66255602001a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page