stdbm

Sentence-Tag DataBase Manager

About

Simple manager for databases with sentences-tags relationship

• Sentence-tag relationship is 1:N;
• I/O operations with csv files.

Usage

stdbm 
Sentences-tags database manager

USAGE:
    stdbm <SUBCOMMAND>

OPTIONS:
    -h, --help    Print help information

SUBCOMMANDS:
    add              Add new register (to either sentences or tags)
    filter-string    Filter and display datatable registers which contain filter_string
    filter-tag       Filter and display sentences which are related to tag
    help             Print this message or the help of the given subcommand(s)
    link             Link sentence and tag
    list             List registers of datatable
    rm               Remove register by id
    update           Update register value by id

The default configuration file can be found at config/default.toml -- current content:

config_type = "toml"

[data_io]
data_file_type = "csv"
sentences = "assets/sentences.csv"
tags = "assets/tags.csv"
sentences_tags = "assets/sentences_tags.csv"

File structure

.
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   └── workflows
│       └── ci.yml
├── .gitignore
├── Cargo.toml
├── LICENSE.md
├── README.md
├── assets
│   ├── sentences.csv
│   ├── sentences_tags.csv
│   └── tags.csv
├── config
│   └── default.toml
└── src
    ├── data_structures.rs
    ├── db_operations.rs
    ├── settings.rs
    └── stdbm.rs

License

Licensed under Apache 2.0.

Development

Create a New Tag & Run CI

The CI pipeline (.github/workflows/ci.yml) runs every time a new tag is pushed.

To push a new git tag the following command can be used:

git tag v<MAJOR>.<MINOR>.<PATCH> && git push origin --tag

For example:

git tag v0.1.0 && git push origin --tag

[WIP] Current TODOs

• Work on missing functionalities:
  • Update record
  • Remove record
• Overall improvements - good practices
  • Add tests
  • Improve reusability of functions