{"id":20937760,"url":"https://github.com/willwade/abbreviation-finder","last_synced_at":"2025-08-21T20:18:18.686Z","repository":{"id":231473543,"uuid":"781834348","full_name":"willwade/Abbreviation-Finder","owner":"willwade","description":"A quick tool to help find good abbrevations to use from some txt docs","archived":false,"fork":false,"pushed_at":"2024-04-13T19:54:02.000Z","size":110,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-19T20:24:04.835Z","etag":null,"topics":["assistive-technology"],"latest_commit_sha":null,"homepage":"https://abbreviation-finder.streamlit.app","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willwade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-04T06:05:02.000Z","updated_at":"2024-08-01T08:17:04.000Z","dependencies_parsed_at":"2024-04-13T20:48:09.015Z","dependency_job_id":null,"html_url":"https://github.com/willwade/Abbreviation-Finder","commit_stats":null,"previous_names":["willwade/abbreviation-finder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwade%2FAbbreviation-Finder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwade%2FAbbreviation-Finder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwade%2FAbbreviation-Finder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwade%2FAbbreviation-Finder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willwade","download_url":"https://codeload.github.com/willwade/Abbreviation-Finder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243330323,"owners_count":20274039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["assistive-technology"],"created_at":"2024-11-18T22:45:29.261Z","updated_at":"2025-03-13T03:14:46.347Z","avatar_url":"https://github.com/willwade.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Abbreviation finder\n\nFor many people abbreviations are the quick hack to increase writing speed.\n\nHow do we find though what the abbreviations are someone should use?\n\nfrom [this guide](https://vasilishynkarenka.com/how-to-type-3x-faster/):\n\n\u003e Here’s how to integrate shortcuts into your workflow:\n\u003e \n\u003e - Go bottoms-up. Don’t just download 300 most popular English words but make shortcuts based on your unique needs. This means,\n\u003e - Look for big words. You must become the Sherlock of your own typing. Whenever you catch a big word that you type often, go ahead and set up a shortcut for it. The bigger the word, the more benefit you get. For example, you can take the word “progressive” and turn it into a “pg” shortcut. This reduces the number of symbols you need to type 5x and removes any possibility of typos.\n\u003e - Look for complex words. Anything that requires special symbols, capital letters, or apostrophes must be turned into shortcuts. For example, I have “ive” shortcut for “I’ve” and type two symbols less each time I get to write this word.\n\u003e - Design shortcuts with ergonomics in mind. You must make them as convenient as possible to get really fast. Thus, for a two-symbol shortcut, you need two symbols in different parts of the keyboard. This enables typing the shortcut with two or three different fingers instead of one.\n\u003e - Use the first two letters of the word to make shortcuts easy to remember. The first and last letter will do as well. But if you set up a shortcut that doesn’t make sense to you, you won’t remember it. And shortcuts only help if you use them. For example, I have “ab” for “about” and “rd” for “realized.” For word combos, use first letters of both words; for example, I have a “fe” shortcut that transforms into “for example” and “ac” shortcut that becomes “auto compound” after I hit the space bar.\n\u003e - Design different variations of a shortcut for the same word. When you start typing three times faster, you will inevitably face a system not picking up keys in the right order. Therefore, it’s useful to have different variations of the same shortcut for the same word. For example, I have both “dnt” and “dont” expanding into “don’t.”\n\n## Using this tool\n\n1. Install requirements\n\n```bash\n\npip install nltk\n\n```\n\n2. Prepare your docs as txts\n\nlots of ways to do this. but one way is to use pandoc\n\n```bash\n\npandoc input.docx -t plain -o output.txt\n```\n\nOn Linux/MacOS install pandoc](https://github.com/jgm/pandoc/releases) then use a script like `convert_documents.sh` with `chmod u+x convert_documents.sh` like so\n\n```bash\n#!/bin/bash\n\n# Directory containing your documents\nDOC_DIR=\"/path/to/your/documents\"\n\n# Output file\nOUTPUT_FILE=\"combined_text.txt\"\n\n# Empty or create the output file\n\u003e \"$OUTPUT_FILE\"\n\n# Loop through all supported document files in the directory\nfor file in \"$DOC_DIR\"/*; do\n    echo \"Processing $file...\"\n    # Use Pandoc to convert to plain text and append to the output file\n    pandoc \"$file\" -t plain \u003e\u003e \"$OUTPUT_FILE\"\ndone\n\necho \"All documents have been combined into $OUTPUT_FILE.\"\n```\n\nor windows `convert_documents.bat`\n\n```bat\n@echo off\nsetlocal enabledelayedexpansion\n\nREM Directory containing your documents\nset \"DOC_DIR=path\\to\\your\\documents\"\n\nREM Output file\nset \"OUTPUT_FILE=combined_text.txt\"\n\nREM Empty or create the output file\ntype nul \u003e \"%OUTPUT_FILE%\"\n\nREM Loop through all supported document files in the directory\nfor %%F in (\"%DOC_DIR%\\*\") do (\n    echo Processing %%F...\n    REM Use Pandoc to convert to plain text and append to the output file\n    pandoc \"%%F\" -t plain \u003e\u003e \"%OUTPUT_FILE%\"\n)\n\necho All documents have been combined into %OUTPUT_FILE%.\n```\n\nPut all your docs to review in a target folder e.g ``txts``\n\n\n3. Run it\n\n```bash\npython abbreviation-finder.py path/to/txts-directory\n```\n\nIt then spits out some words/sentences e.g\n\n\n    speaking -\u003e sp\n    Consider -\u003e co\n    directly -\u003e di\n    preferred -\u003e pr\n    practice -\u003e pr\n    literacy -\u003e li\n    extended -\u003e ex\n    languages -\u003e la\n    confused -\u003e co\n    educational -\u003e ed\n    telephone -\u003e te\n    important -\u003e im\n    language -\u003e la\n    situation -\u003e si\n    sentences -\u003e se\n    development -\u003e de\n    conversations -\u003e co\n    activity -\u003e ac\n    alongside -\u003e al\n    more languages -\u003e ml\n    can not -\u003e cn\n    bilingual children -\u003e bc\n    use words -\u003e uw\n\n\nenjoy! \n\n## Refs\n\n- https://news.ycombinator.com/item?id=39916366#39926892\n- https://vasilishynkarenka.com/how-to-type-3x-faster/\n- https://blog.abreevy8.io/you-dont-have-to-type-faster-to-type-faster/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillwade%2Fabbreviation-finder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillwade%2Fabbreviation-finder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillwade%2Fabbreviation-finder/lists"}