rnsrk/goodByeHida
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

!ignore docs and add README

Browse source
This commit is contained in:
rnsrk 2024-02-07 15:45:20 +01:00
parent 52145ecabf
commit 1b566efbab
2 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -16,6 +16,12 @@ pip install -r requirements.txt
```
place the XML files in the `docs` folder or for evaluation purposes few files in the `test-docs` folder.
## Purpose
The program iterates through the docs dir and in a first run, it builds database schemas from the
structure of the XML files, which will be used to create a data model for an SQLlite databse.
In a second iteration, every node with children or node with a "txt" element will be an entity (beginning with c__)
all other elements will be attributes (beginning with f__). Entities will be connected with an uuid
foreign key to their parent entity in relational tables (beginning with r__).
## Usage
To have a test run, place XML-files in a dir named `test-docs`, then type
```bash