capture_bot_san/README.md

30 lines
1.1 KiB
Markdown

# Capture Bot San
Tiny software for "capturing" everything as well as possible, via discord and markdown file on dropbox with attached images/movies.
## Prerequisites
- [poetry](https://python-poetry.org/) installed Note: 1.8 or newer. Install manually when your OS package system installs older version. For example raspberry pi OS installs 1.3 on 2024/Mar/11.
- Own discord server and bot(with permission "Read Messages/View Channels")
- Dropbox App with following setup
- Scoped App
- Permission files.content.write, files.content.read
## Setup
```shell
$ poetry install
```
## How to run
```shell
$ poetry run python -m capture_bot_san
```
For the 1st run(or when it detects lacking any tokens/configs required), it will prompt to gather required access tokens and configurations. Input all of them accordingly.
# Configuration
- tokens are stored in .env
- configs are stored in config.yaml
- `DROPBOX_TEXTFILE_FOLDER`: Location of the markdown file to tweak with this software
- `MARKDOWN_FILENAME`: Filename of the markdown file
- `DROPBOX_MEDIA_FOLDER`: Location of the images and videos to be uploaded