Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaypyles/obsidian-to-bookstack
Download and upload changes between an Obsidian Vault and a Bookstack instance.
https://github.com/jaypyles/obsidian-to-bookstack
bookstack obsidian python
Last synced: 3 months ago
JSON representation
Download and upload changes between an Obsidian Vault and a Bookstack instance.
- Host: GitHub
- URL: https://github.com/jaypyles/obsidian-to-bookstack
- Owner: jaypyles
- License: mit
- Created: 2023-12-20T02:22:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-24T01:24:40.000Z (12 months ago)
- Last Synced: 2024-10-01T09:41:45.752Z (3 months ago)
- Topics: bookstack, obsidian, python
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 56
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Summary
Download remote files from Bookstack instance, that you may not have, along with sending any changes to the remote.
After configuration, consider installing the companion plugin at https://github.com/jaypyles/ObsidianToBookstackPlugin.
# 🆕 What's New
- All commands will now also be available to use with chapters. This means that
a structure like this is now allowed:
```
- Shelf/
-- Book/
--- Chapter/
---- Note.md
--- Note.md
```
# Installing
Run with `pipx install .` inside the project to install to your machine.
# Config
You can use a `.env` file for the following secrets:
`BOOKSTACK_BASE_URL="https://demo.bookstack.com"`
`BOOKSTACK_TOKEN_ID=`
`BOOKSTACK_TOKEN_SECRET=`
or you may choose to use whatever secret manager you want, like Doppler, so long as it sets those environment variables.
By default, the tool will look for `.env` in the root of the project, but can be set anywhere using the `--env` flag.
Configuration by default is located at `~/.config/obsidian_to_bookstack/conf.toml` but can also be set anywhere using the `--config` flag.
The format of the configuration file is as follows:
```toml
[wiki]
path = "/home/user/notes/"
[wiki.excluded]
shelves = ["private"]
```
Any shelves in `wiki.excluded.shelves` will not be uploaded to Bookstack.
## Configuring CLI Options
- **Verbose Mode**
- `-v`, `--verbose`: This optional flag enables verbose logs, providing more detailed information during command execution.
- **Config File**
- `-c`, `--config`: Specify the path to a configuration file (`*.toml`). If provided, the CLI will load settings from this file. If not specified, default settings will be used.
- **Environment File**
- `-e`, `--env`: Specify the path to an environment file (`.env`).
Running commands after specifying config paths will continue with the last used path.
## Structure
The structure of the Obsidian Vault is pretty specific as it mirrors the Bookstack structure to be as in sync as possible.
```
- Shelves
- Books
- Chapter
- Pages.md
- Pages.md
```
## Commands
### Sync
Calls `local` and `remote`
### Local
Pulls down any missing local files
### Remote
Pushes up any missing files in the remote
### Update
Requires either the `--remote` or the `--local` flag.
If `--remote` is specified, any files which have been updated locally will be changed in the remote and vice-versa for `--local`.
### Delete
Requires one of `--shelf`, `--book`, `--page`. Will delete Obsidian files and Bookstack files at the same time. Anything nested under a shelf or book will also be deleted.
Must be called in a path like structure. Ex:
```bash
- Shelf
- Book
- Chapter
- Page.md
- Page.md
```
The command would be called as `obsidian_to_bookstack delete Shelf/Book/Page --page` to delete a page.
Optional configuration commands must be ran as:
`obsidian_to_bookstack --verbose --config ~/.config/.. --env ~/.config/... `
## In Progress
- Statistical/table view of uploaded, downloaded, deleted, or updated objects