{"id":21492135,"url":"https://github.com/johannesbuchner/languagecheck","last_synced_at":"2025-07-15T17:33:02.030Z","repository":{"id":66659312,"uuid":"59239911","full_name":"JohannesBuchner/languagecheck","owner":"JohannesBuchner","description":"Improve the language of your paper before submission","archived":false,"fork":false,"pushed_at":"2023-07-24T02:13:53.000Z","size":5042,"stargazers_count":93,"open_issues_count":0,"forks_count":13,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-16T07:05:48.154Z","etag":null,"topics":["grammar-checker","language-analysis","latex","overleaf","proof-reading","publishing","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JohannesBuchner.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2016-05-19T20:23:29.000Z","updated_at":"2024-04-08T22:00:35.000Z","dependencies_parsed_at":"2024-01-03T05:41:49.946Z","dependency_job_id":"8a92c598-6f63-4d15-b389-60ec6c6db54f","html_url":"https://github.com/JohannesBuchner/languagecheck","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2Flanguagecheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2Flanguagecheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2Flanguagecheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2Flanguagecheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohannesBuchner","download_url":"https://codeload.github.com/JohannesBuchner/languagecheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226059056,"owners_count":17567189,"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":["grammar-checker","language-analysis","latex","overleaf","proof-reading","publishing","python"],"created_at":"2024-11-23T15:22:48.487Z","updated_at":"2024-11-23T15:22:49.082Z","avatar_url":"https://github.com/JohannesBuchner.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Language checking for scientific papers\n--------------------------------------------\n\nThis program attempts to assist you in improving your paper before submission.\n\nFeatures\n---------\n\n* Can analyse any LaTeX papers, and Overleaf projects.\n* Makes automated reports to point you to improvements:\n\n  * Word level:\n\n    * find common grammar mistakes, like wrong prepositions\n    * find wordy phrases and suggest replacements\n    * a vs an\n    * spell-check (using hunspell)\n\n  * Sentence level:\n\n    * find long, wordy sentences\n    * check topic sentences\n\n  * Paragraph level:\n\n    * find tense inconsistencies\n\n  * Paper level:\n\n    * check visual impression of paper\n\n* All analysis is done offline -- your text does not leave your computer.\n* Supports British and American English, but focusses on issues applying to both.\n\nNote that there are false positives -- only you can decide whether a \nchange would make sense, the reports only point out potential issues.\n\nIf you find some rules useless (too many false positives), or you want to add more, please send a pull request!\n\nDemo output\n-------------\n\nExample analysis (of an early draft of `this paper \u003chttp://adsabs.harvard.edu/abs/2017MNRAS.465.4348B\u003e`_):\n\n* `Example report for misused phrases \u003chttps://johannesbuchner.github.io/languagecheck/demo/agnpaper.txt_tricky.html\u003e`_\n* `Overview of all reports \u003chttps://johannesbuchner.github.io/languagecheck/demo/agnpaper.txt_index.html\u003e`_\n\nRequirements\n-------------\n\n* python\n* convert command (ImageMagick): Install with your distribution\n* nltk: Install with pip\n* nltk data: Install with python -m nltk.downloader all\n* detex command (usually comes with LaTeX)\n* pyhunspell (optional): Install with pip\n\nInstallation\n--------------\n\nThese commands should not give you an error::\n\n\t$ which convert\n\t$ which python\n\t$ which detex\n\t$ which hunspell\n\t$ ls /usr/share/hunspell/{en_US,en_UK}.{dic,aff}\n\nThen install the python packages and data::\n\n\t$ pip install pyhunspell  --user\n\t$ pip install nltk  --user\n\t$ python -m nltk.downloader cmudict stopwords punkt averaged_perceptron_tagger\n\n\nUsage\n--------------\n\n*Using directly*:\n\n* create PDF from your latex file -\u003e mypaper.pdf\n\n  * For example, run \"pdflatex mypaper.tex\"\n\n* use detex to create pure text file -\u003e mypaper.txt\n\n  * For example, run \"detex mypaper.tex \u003e mypaper.txt\". You need detex installed.\n  * This does not capture figure captions. The detex.sh script can help you include those texts, \"bash detex.sh mypaper.tex\". You still need detex installed\n\n* run $ python languagecheck.py mydir/mypaper.txt mydir/mypaper.pdf\n* open with a web browser mypaper_index.html to see all reports\n\n*Using with Overleaf*::\n\n\t$ bash languagecheck_overleaf.sh \u003coverleaf_url\u003e \u003cname of tex file\u003e\n\t# for example:\n\t$ bash languagecheck_overleaf.sh https://www.overleaf.com/123456789 mypaper.tex\n\nSee also\n---------\n\n* style-check, a similar program written in Ruby: https://github.com/nspring/style-check/\n* Statistics checklist:  Check for common statistics mistakes with this checklist\n   http://astrost.at/istics/minimal-statistics-checklist.html\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannesbuchner%2Flanguagecheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohannesbuchner%2Flanguagecheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannesbuchner%2Flanguagecheck/lists"}