This repository was archived by the owner on Apr 5, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +10
-9
lines changed
Expand file tree Collapse file tree 1 file changed +10
-9
lines changed Original file line number Diff line number Diff line change 11# bookstack
2- version: 0.1.0-alpha.2
2+ * version: 0.1.0-alpha.2*
3+
4+ ** Please note that this project is currently in an unstable state. Please be patient.**
35
46A Python wrapper for [ BookStack's] ( https://www.bookstackapp.com ) API
57
@@ -8,22 +10,21 @@ To install `bookstack`, run:
810
911` pip install bookstack `
1012
11- # Usage
13+ # Setup
1214To use BookStack's API, you'll need to get a token ID and secret.
1315
1416You can find how to get these values from your BookStack instance's doc page at ` http[s]://<example.com>/api/docs `
1517
18+ # Usage
19+ Once you've acquired your token ID and secret, you're ready to rock.
20+
1621``` python
1722import bookstack
1823
1924# Input the appropriate values for these three variables
2025base_url = ' http[s]://<example.com>'
2126token_id = ' <token_id>'
22- token_secret = ' <token_secret' >
23-
24- api = bookstack.BookStack(base_url, token_id = < token_id> , token_secret = < token_secret> )
25- ```
27+ token_secret = ' <token_secret>'
2628
27- ## TODO
28- - Documentation
29- - Remove ` tests ` directory from ` .gitignore `
29+ api = bookstack.BookStack(base_url, token_id = token_id, token_secret = token_secret)
30+ ```
You can’t perform that action at this time.
0 commit comments