130 lines
3.7 KiB
Markdown
130 lines
3.7 KiB
Markdown
# kotaemon
|
|
|
|
Quick and easy AI components to build Kotaemon - applicable in client
|
|
project.
|
|
|
|
## Install
|
|
|
|
```shell
|
|
pip install kotaemon@git+ssh://git@github.com/Cinnamon/kotaemon.git
|
|
```
|
|
|
|
## Contribute
|
|
|
|
### Setup
|
|
|
|
- Create conda environment (suggest 3.10)
|
|
|
|
```shell
|
|
conda create -n kotaemon python=3.10
|
|
conda activate kotaemon
|
|
```
|
|
|
|
- Clone the repo
|
|
|
|
```shel
|
|
git clone git@github.com:Cinnamon/kotaemon.git
|
|
cd kotaemon
|
|
```
|
|
|
|
- Install all
|
|
|
|
```shell
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
- Pre-commit
|
|
|
|
```shell
|
|
pre-commit install
|
|
```
|
|
|
|
- Test
|
|
|
|
```shell
|
|
pytest tests
|
|
```
|
|
|
|
### Credential sharing
|
|
|
|
This repo uses [ssh-secret](https://sobolevn.me/git-secret/) to share credentials, which internally uses `gpg` to encrypt and decrypt secret files.
|
|
|
|
#### Install git-secret
|
|
|
|
Please follow the [official guide](https://sobolevn.me/git-secret/installation) to install git-secret.
|
|
|
|
#### Gaining access
|
|
|
|
In order to gain access to the secret files, you must provide your gpg public file to anyone who has access and ask them to ask your key to the keyring. For a quick tutorial on generating your gpg key pair, you can refer to the `Using gpg` section from the [ssh-secret main page](https://sobolevn.me/git-secret/).
|
|
|
|
#### Decrypt the secret file
|
|
|
|
The credentials are encrypted in the `credentials.txt.secret` file. To print the decrypted content to stdout, run
|
|
|
|
```shell
|
|
git-secret cat [filename]
|
|
```
|
|
|
|
Or to get the decrypted `credentials.txt` file, run
|
|
|
|
```shell
|
|
git-secret reveal [filename]
|
|
```
|
|
|
|
#### For Windows users
|
|
|
|
ssh-secret is currently not available for Windows, thus the easiest way is to use it in WSL (please use the latest version of WSL2). From there you have 2 options:
|
|
|
|
1. Using the gpg of WSL.
|
|
|
|
This is the most straight-forward option since you would use WSL just like any other unix environment. However, the downside is that you have to make WSL your main environment, which means WSL must have write permission on your repo. To achieve this, you must either:
|
|
|
|
- Clone and store your repo inside WSL's file system.
|
|
- Provide WSL with necessary permission on your Windows file system. This can be achieve by setting `automount` options for WSL. To do that, add these content to `/etc/wsl.conf` and then restart your sub-system.
|
|
|
|
```shell
|
|
[automount]
|
|
options = "metadata,umask=022,fmask=011"
|
|
```
|
|
|
|
This enables all permissions for user owner.
|
|
|
|
2. Using the gpg of Windows but with ssh-secret from WSL.
|
|
|
|
For those who use Windows as the main environment, having to switch back and forth between Windows and WSL will be inconvenient. You can instead stay within your Windows environment and apply some tricks to use `ssh-secret` from WSL.
|
|
|
|
- Install and setup `gpg` on Windows.
|
|
- Install `ssh-secret` on WSL.
|
|
- Make WSL use the `gpg` executable from Windows. This can be done by alias `gpg` to your Windows executable `gpg.exe` file. Add this content to your startup script:
|
|
|
|
```shell
|
|
# Create ~/bin if it doesn't exist
|
|
[ ! -d "$HOME/bin" ] && mkdir "$HOME/bin"
|
|
|
|
# link windows executable
|
|
ln -snf "$(which gpg.exe)" "$HOME/bin/gpg"
|
|
|
|
# Prepend $HOME/bin to PATH
|
|
if [[ ":$PATH:" == *":$HOME/bin:"* ]]; then
|
|
export PATH="$HOME/bin:$PATH"
|
|
fi
|
|
```
|
|
|
|
- Now in Windows, you can invoke `ssh-secret` using `wsl ssh-secret`.
|
|
- Alternatively you can setup alias in CMD to shorten the syntax. Please refer to [this SO answer](https://stackoverflow.com/a/65823225) for the instruction. Some recommended aliases are:
|
|
|
|
```bat
|
|
@echo off
|
|
|
|
:: Commands
|
|
DOSKEY ls=dir /B $*
|
|
DOSKEY ll=dir /a $*
|
|
DOSKEY git-secret=wsl git-secret $*
|
|
DOSKEY gs=wsl git-secret $*
|
|
```
|
|
|
|
### Code base structure
|
|
|
|
- documents: define document
|
|
- loaders
|