You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
z31t 0663adde6e init 1 year ago
README.md init 1 year ago
abbdb.yaml init 1 year ago
abbs.py init 1 year ago
csv-import.csv init 1 year ago
import-wiki.py init 1 year ago
infodb.yaml init 1 year ago

README.md

Building my database for abbreviations

Requirements

  • Python 3.0<
  • PyYAML 5.1<

Status

Create a YAML database, add abbreviations from the terminal, start a quiz to study

Usage

Add abbreviaton from terminal

python3 abbs.py add [abbreviation] ["description"] [tag]

Start quiz

python3 abbs.py quiz

Asks you what the description of the abbreviation is.

Status quo:

  • case sensitive
  • randomized
  • doesn't repeat words but resets after every word was used

Short quiz without input

python3 abbs.py random

Shows you random abbreviations and presents you the answer after you press 'Enter'

Search function

python3 abbs.py search *searchterm*

Import csv file

python3 abbs.py csv [file]

Example for the syntax:

LAN,Local Area Network,network

Default csv-file is name 'csv-import.csv'. Optional choose another one via terminal.

delimiter: comma ',' - only one tag for now - no check for dublications (dublicates are getting updated)

TODO

  • add search function
    • tag filter (implemented, but not functional)
  • Random function
    • Show wiki infos if ? is entered
    • import thing sfrom Technopedia
    • Prevent dublicates, not important
  • add abbreviations from terminal
    • check for dublicates (currently checking the 'desc' value)
    • add fields for additional information like wikipedia page next
      • import first paragraph for questions
    • multiple tags
    • Notification, when format is wrong or field is missing
  • add search function
  • add a quiz for the terminal
    • Save results in seperate db?
    • Don't show entries multiple times, but reset after every word was used
    • yaml, csv, json?
    • check for dublicates (primary key (abbs, desc))
  • Import database
    • import csv file
    • check for dubilcates if necessary
    • name of csv file hard coded. Give option in command line.
  • export to html/md file for docs
  • change the layout, work with colors
  • think about the data structure again

Troubleshooting

module 'yaml' has no attribute 'FullLoader'

The 'Fullloader' class is only available in PyYAML 5.1 and later. You can check your current PyYAML version as followed:

python3
>>> import yaml
>>> yaml.__version__
'3.13'

You can update your version with pip:

pip3 install -U PyYAML