https://github.com/settorka/genandscoreabbreviations
Generate and score abbreviations with three English Alphabets from lines of words from a text file.
https://github.com/settorka/genandscoreabbreviations
filtering indexing iterable unique-id-generator
Last synced: about 1 year ago
JSON representation
Generate and score abbreviations with three English Alphabets from lines of words from a text file.
- Host: GitHub
- URL: https://github.com/settorka/genandscoreabbreviations
- Owner: settorka
- Created: 2023-12-14T17:03:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T04:31:51.000Z (over 2 years ago)
- Last Synced: 2025-04-09T12:14:22.039Z (over 1 year ago)
- Topics: filtering, indexing, iterable, unique-id-generator
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# genAndScoreAbbreviations
This program generates and scores abbreviations from a list of names, represented as single lines of text in a file. It consists of four Python files:
- **main.py** to run the program to score and generate abbreviations
- **fileProcessors.py** to read values from the scorecard(value.txt) and the list of names (user inputs a text file which is located in the current directory)
- **abbreviationRules.py** to convert the names to uppercase, filter out non-alphabets and generate three-letter abbreviations
- **scoreAbbreviations.py** to score the non-duplicate abbreviations based on the scorecard, first and last letter index values.
It also includes two text files: **values.txt** for the scorecard and **trees.txt** to test the program
To view the tests on the program, switch to the **"test"** branch
The program reads each line as a phrase or word hence the list of names need to be on multiple lines, as shown in **trees.txt**.
The program was tested using words(compound (-), words with foreign letters, long words, words shorter than three) and phrases.
The final output of the program will potentially be stored as
Cold
CLD
for each name with generated abbreviations in the file amediku_fileName_abbrevs.txt where
- CLD is the least scored generated abbreviation
- fileName is the fileName given