Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
david-loe committed Oct 22, 2024
1 parent dd34daf commit 9049763
Showing 1 changed file with 26 additions and 18 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,29 @@

Syncronisation zwischen Frappe und Optigem / GDI Lohn & Gehalt

## Setup
## Run

### 1. Pakete installieren
using docker

```
pip install -r requirements.txt
docker run -v ./config.yaml:/config.yaml davidloe/frappe-optigem-gdi-sync --config /config.yaml
```

### 2. pyodbc MSSQL Treiber installieren

https://github.com/mkleehammer/pyodbc/wiki/Install
or running locally

### 3. Firebird Client Library installieren
```
script.py
```

https://firebirdsql.org/file/documentation/reference_manuals/driver_manuals/odbc/html/fbodbc205-install.html
```
options:
-h, --help show this help message and exit
--loglevel LOGLEVEL Setzt das Loglevel (DEBUG, INFO, WARNING, ERROR, CRITICAL)
--config CONFIG Pfad zur Konfigurationsdatei
--dry-run Führt den Sync im Dry-Run-Modus aus (keine Änderungen werden vorgenommen)
```

### 4. Config anpassen
## Config anpassen

```
cp config.yaml.example config.yaml
Expand Down Expand Up @@ -46,16 +52,18 @@ cp config.yaml.example config.yaml
- Optional: `key_fields` (für Updates)
- Optional: `create_new` (wenn `true` werden neue Dokumente in der Datenbank eingefügt, für die kein match anhand der `key_fields` gefunden wurde)

## Run
## Setup Local

```
python sync.py
```
### 1. pyodbc MSSQL Treiber installieren

https://github.com/mkleehammer/pyodbc/wiki/Install

### 2. Firebird Client Library installieren

https://firebirdsql.org/file/documentation/reference_manuals/driver_manuals/odbc/html/fbodbc205-install.html

### 3. Pakete installieren

```
options:
-h, --help show this help message and exit
--loglevel LOGLEVEL Setzt das Loglevel (DEBUG, INFO, WARNING, ERROR, CRITICAL)
--config CONFIG Pfad zur Konfigurationsdatei
--dry-run Führt den Sync im Dry-Run-Modus aus (keine Änderungen werden vorgenommen)
pip install -r requirements.txt
```

0 comments on commit 9049763

Please sign in to comment.