thomasabishop/eolas-db
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
Thomas Bishop 2025-10-19 12:02:25 +01:00
parent 6df4c5be07
commit 1efdd12510
1 changed files with 28 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,15 +1,21 @@
# eolas-db # eolas-db
This CLI application parses entries in my This CLI application parses entries in my
[zettelkasten](https://github.com/thomasabishop/eolas) and extracts key metadata [zettelkasten](https://github.com/thomasabishop/eolas), extracts the content
about each entry. It creates and populates an SQLite database and offers different options for and metadata for each entry inserts into an SQLite database.
exporting representations of the relations.
It takes two parameters:
- `--source`
- A file reference to the location of the markdown files comprising the Zettelkasten
- `--target`
- A file reference designating where the SQLite file should be saved.
## Local development ## Local development
```sh ```sh
source venv/bin/activate source venv/bin/activate
python3 src/cli.py [opts] python3 src/app.py --source="/my-zettelkasten-entries" --target="/tmp/zettelkasten-output-dir"
``` ```
## Production ## Production
@ -18,42 +24,33 @@ python3 src/cli.py [opts]
```sh ```sh
source venv/bin/activate source venv/bin/activate
pyinstaller --onefile ${HOME}/repos/eolas-db/src/cli.py --name eolas-db [opts] pyinstaller --onefile ${HOME}/eolas-db/src/app.py
``` ```
Will build to the `/dist` directory of this repo when run locally.
### Run executable ### Run executable
```sh ```sh
${HOME}/repos/eolas-db/dist/eolas-db ${HOME}/eolas-db/dist/app --source="/my-zettelkasten-entries" --target="/tmp/zettelkasten-output-dir"
``` ```
Or:
```sh
sudo mv ${HOME}/repos/eolas-db/dist/ /usr/local/bin
eolas-db [opts]
```
## Options
### `populate`
Parse entries and extract key metadata and body text, import into database
tables.
### `generate-graph`
Output a network graph of connections between entries and tags
### `export-tags`
Export a one-to-many JSON object of tags to entries.
## ERM ## ERM
![ERM diagram for eolas-db](./eolas-db-ERM.png) ![ERM diagram for eolas-db](./eolas-db-ERM.png)
## Resources ## Related projects
https://www.digitalocean.com/community/tutorials/how-to-use-the-sqlite3-module-in-python-3 ### [eolas](https://forgejo.systemsobscure.net/thomasabishop/eolas)
The repository for the Zettelkasten that this application reads from.
### [eolas-api](https://forgejo.systemsobscure.net/thomasabishop/eolas-api)
A NodeJS Express API which sources its data from database created by
this application.
### [eolas-app](https://forgejo.systemsobscure.net/thomasabishop/eolas-app)
A web frontend for the application, deployed at
[eolas-app.systemsobscure.net](https://eolas-app.systemsobscure.net).