A Python wrapper for BookStack's API
Project description
bookstack
version: 0.1.0-beta
Please note that this project is currently in an unstable state. Please be patient.
A Python wrapper for BookStack's API
Installation
To install bookstack
, run:
pip install bookstack
Setup
To use BookStack's API, you'll need to get a token ID and secret.
You can find how to get these values from your BookStack instance's doc page at http[s]://<example.com>/api/docs
Note: Your account's user group must have API usage priveleges enabled.
Usage
Once you've acquired your token ID and secret, you're ready to rock.
>>> import bookstack
# Input the appropriate values for these three variables
>>> base_url = 'http[s]://<example.com>'
>>> token_id = '<token_id>'
>>> token_secret = '<token_secret>'
>>> api = bookstack.BookStack(base_url, token_id=token_id, token_secret=token_secret)
This wrapper dynamically generates its API calls at runtime. To have the wrapper generate the methods, use:
>>> api.generate_api_methods()
>>> api.available_api_methods
{'get_books_export_pdf', 'get_shelves_list', 'post_books_create', 'get_docs_display', 'delete_shelves_delete', 'get_books_list', 'get_docs_json', 'delete_books_delete', 'get_books_read', 'get_shelves_read', 'put_books_update', 'get_books_export_plain_text', 'get_books_export_html', 'post_shelves_create', ...}
The above are then the methods available to you, for example:
>>> books_list = api.get_books_list()
>>> books_list['data'][0]['name']
'Mathematics'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bookstack-0.1.0b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f4bc92ac2e26673d546f76b144de1ba0a2113e630954dd53cac7b8242c8a11a |
|
MD5 | 3063c2cfdc3ff7ff873020d7393e524b |
|
BLAKE2b-256 | 3db1360188ce275a3f41c854064d928cdb3322604ddc6c30c205dba35f72ca04 |