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:
thomasabishop 2025-01-21 17:43:59 +00:00
parent c42ee2eb28
commit d9eb039663
1 changed files with 27 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -2,44 +2,54 @@
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) and extracts key metadata
about each entry. It creates and populates an SQLite database and offers options for about each entry. It creates and populates an SQLite database and offers different options for
exporting mapped relations between entries. exporting representations of the relations.
## Local development ## Local development
``` ```sh
source venv/bin/activate source venv/bin/activate
eolas-db [opts] python3 src/cli.py [opts]
``` ```
## Production ## Production
After development is complete, instead of compiling to a single executable I can just install the application ### Generate single executable
with `pipx` like any other.
``` ```sh
pipx install [local_path_to_application] source venv/bin/activate
eolas-db [opts] pyinstaller --onefile ${HOME}/repos/eolas-db/src/cli.py --name eolas-db [opts]
``` ```
### Update after changes ### Run executable
```sh
${HOME}/repos/eolas-db/dist/eolas-db
``` ```
pipx uninstall eolas-db
pipx install [local_path_to_application] Or:
```sh
sudo mv ${HOME}/repos/eolas-db/dist/ /usr/local/bin
eolas-db [opts]
``` ```
## Options ## Options
### `populate` ### `populate`
``` Parse entries and extract key metadata and body text, import into database
eolas-db populate
```
Parse Eòlas entries and extract key metadata and body text, import into database
tables. 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)