AF2C
/
vetting-bot
23
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

Update setup instructions

This commit is contained in:
Panoramic 2024-06-10 22:49:46 +03:00
parent 04b9dabccb
commit 995ad51b93
Signed by: Panoramic
GPG Key ID: 29FEDD73E66D32F1
1 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
SETUP.md
View File

@ -39,6 +39,10 @@ remove the option altogether to allow all addresses.
If you would rather not or are unable to run docker, the following will If you would rather not or are unable to run docker, the following will
instruct you on how to install the dependencies natively: instruct you on how to install the dependencies natively:
#### Install Poetry
[Python Poetry install guide](https://python-poetry.org/docs/#installation)
#### Install libolm #### Install libolm
You can install [libolm](https://gitlab.matrix.org/matrix-org/olm) from source, You can install [libolm](https://gitlab.matrix.org/matrix-org/olm) from source,
@ -68,24 +72,8 @@ sudo pacman -S postgresql-libs
#### Install Python dependencies #### Install Python dependencies
Create and activate a Python 3 virtual environment:
``` ```
virtualenv -p python3 env poetry install
source env/bin/activate
```
Install python dependencies:
```
pip install -e .
```
(Optional) If you want to use postgres as a database backend, use the following
command to install postgres dependencies alongside those that are necessary:
```
pip install -e ".[postgres]"
``` ```
## Configuration ## Configuration
@ -126,25 +114,20 @@ Refer to the docker [run instructions](docker/README.md#running).
Make sure to source your python environment if you haven't already: Make sure to source your python environment if you haven't already:
``` ```
source env/bin/activate poetry shell
``` ```
Then simply run the bot with: Then simply run the bot with:
``` ```
my-project-name ./vetting-bot
``` ```
You'll notice that "my-project-name" is scattered throughout the codebase. When
it comes time to modifying the code for your own purposes, you are expected to
replace every instance of "my-project-name" and its variances with your own
project's name.
By default, the bot will run with the config file at `./config.yaml`. However, an By default, the bot will run with the config file at `./config.yaml`. However, an
alternative relative or absolute filepath can be specified after the command: alternative relative or absolute filepath can be specified after the command:
``` ```
my-project-name other-config.yaml ./vetting-bot other-config.yaml
``` ```
## Testing the bot works ## Testing the bot works