{"id":16814469,"url":"https://github.com/findus23/pylanguagetool","last_synced_at":"2025-04-06T06:09:09.073Z","repository":{"id":49355351,"uuid":"79461237","full_name":"Findus23/pyLanguagetool","owner":"Findus23","description":"Python Library and CLI for the LanguageTool JSON API","archived":false,"fork":false,"pushed_at":"2024-07-20T21:39:38.000Z","size":271,"stargazers_count":125,"open_issues_count":10,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-14T10:29:35.408Z","etag":null,"topics":["cli","grammar","languagetool","spell-check","spellcheck"],"latest_commit_sha":null,"homepage":"https://pylanguagetool.lw1.at/","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/Findus23.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","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":"2017-01-19T14:28:24.000Z","updated_at":"2024-09-18T00:11:35.000Z","dependencies_parsed_at":"2024-10-25T18:38:53.096Z","dependency_job_id":"b7747fd2-b273-4f29-9b6d-8638a5453a6c","html_url":"https://github.com/Findus23/pyLanguagetool","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Findus23%2FpyLanguagetool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Findus23%2FpyLanguagetool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Findus23%2FpyLanguagetool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Findus23%2FpyLanguagetool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Findus23","download_url":"https://codeload.github.com/Findus23/pyLanguagetool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441052,"owners_count":20939239,"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":["cli","grammar","languagetool","spell-check","spellcheck"],"created_at":"2024-10-13T10:29:31.922Z","updated_at":"2025-04-06T06:09:09.049Z","avatar_url":"https://github.com/Findus23.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============\npyLanguagetool\n==============\n|license| |latestrelease| |pypi_versions|\n\nA python library and CLI for the LanguageTool_ `JSON API`_.\n\nLanguageTool_ is an open source spellchecking platform. It supports a large\nvariety of languages and has advanced grammar support.\n\n.. image:: https://pylanguagetool.lw1.at/_images/screenshot.png\n\n.. start-of-homepage-text\n\nInstallation\n------------\npyLanguagetool can be installed with pip/pipenv:\n\n.. code:: bash\n\n    pip install pylanguagetool\n    # or via pipenv\n    pipenv install pylanguagetool\n\nBasic Usage\n-----------\n.. code:: bash\n\n    # pipe text to pylanguagetool\n    echo \"This is a example\" | pylanguagetool\n\n    # read text from a file\n    pylanguagetool textfile.txt\n\n    # read text from stdin\n    pylanguagetool \u003c textfile.txt\n\n    # read text from the systems clipboard\n    pylanguagetool -c # get text from system clipboard\n\nAll samples above will return a list of detected errors and possible\nreplacements.\n\n.. code::\n\n    # Use \"an\" instead of 'a' if the following word starts with a vowel sound, e.g. 'an article', 'an hour'\n    #   ✗ This is a example\n    #             ^\n    #   ✓ This is an example\n\n\n\nConfiguration\n-------------\nAll `LanguageTool API`_ parameters can be set via command line arguments,\nenvironment variables or a configuration file\n(``~/.config/pyLanguagetool.conf``) For more information about the\nconfiguration file syntax, read the `ConfigArgParse documentation`_.\n\nPrivacy\n-------\n\nBy default, pyLanguagetool sends all text via HTTPS to the `LanguageTool`_\nserver (see their `privacy policy`_). You can also `set up your own server`_ and\nuse it by changing the ``--api-url`` attribute.\n\nParameters\n----------\n\n.. code::\n\n    $ pylanguagetool --help\n    usage: pylanguagetool [-h] [-V] [-v] [-a API_URL] [--no-color] [-c] [-s]\n                          [-t {txt,html,md,markdown,rst,ipynb,json,xliff}] [-u]\n                          [-r] [--rule-categories] [-l LANG] [-m MOTHER_TONGUE]\n                          [-p PREFERRED_VARIANTS] [-e ENABLED_RULES]\n                          [-d DISABLED_RULES]\n                          [--enabled-categories ENABLED_CATEGORIES]\n                          [--disabled-categories DISABLED_CATEGORIES]\n                          [--enabled-only] [--picky] [-U USERNAME] [-P API_KEY]\n                          [--pwl PWL]\n                          [input files ...]\n\n    positional arguments:\n      input files           input file(s)\n\n    options:\n      -h, --help            show this help message and exit\n      -V, --version         print version and exit\n      -v, --verbose         verbose output [env var: VERBOSE]\n      -a, --api-url API_URL\n                            the URL of the v2 languagetool API, should end with\n                            '/v2/' [env var: API_URL]\n      --no-color            don't color output [env var: NO_COLOR]\n      -c, --clipboard       get text from system clipboard [env var: CLIPBOARD]\n      -s, --single-line     check every line on its own [env var: SINGLE_LINE]\n      -t, --input-type {txt,html,md,markdown,rst,ipynb,json,xliff}\n                            if not plaintext [env var: INPUT_TYPE]\n      -u, --explain-rule    print URLs with more information about rules [env var:\n                            EXPLAIN_RULE]\n      -r, --rules           show the matching rules [env var: RULES]\n      --rule-categories     show the the categories of the matching rules [env\n                            var: RULE_CATEGORIES]\n      -l, --lang LANG       A language code like en or en-US, or auto to guess the\n                            language automatically (see preferredVariants below).\n                            For languages with variants (English, German,\n                            Portuguese) spell checking will only be activated when\n                            you specify the variant, e.g. en-GB instead of just\n                            en. [env var: TEXTLANG]\n      -m, --mother-tongue MOTHER_TONGUE\n                            A language code of the user's native language,\n                            enabling false friends checks for some language pairs.\n                            [env var: MOTHER__TONGUE]\n      -p, --preferred-variants PREFERRED_VARIANTS\n                            Comma-separated list of preferred language variants.\n                            The language detector used with language=auto can\n                            detect e.g. English, but it cannot decide whether\n                            British English or American English is used. Thus this\n                            parameter can be used to specify the preferred\n                            variants like en-GB and de-AT. Only available with\n                            language=auto. [env var: PREFERRED_VARIANTS]\n      -e, --enabled-rules ENABLED_RULES\n                            IDs of rules to be enabled, comma-separated [env var:\n                            ENABLED_RULES]\n      -d, --disabled-rules DISABLED_RULES\n                            IDs of rules to be disabled, comma-separated [env var:\n                            DISABLED_RULES]\n      --enabled-categories ENABLED_CATEGORIES\n                            IDs of categories to be enabled, comma-separated [env\n                            var: ENABLED_CATEGORIES]\n      --disabled-categories DISABLED_CATEGORIES\n                            IDs of categories to be disabled, comma-separated [env\n                            var: DISABLED_CATEGORIES]\n      --enabled-only        enable only the rules and categories whose IDs are\n                            specified with --enabled-rules or --enabled-categories\n      --picky               if enabled, additional rules will be activated\n      -U, --username USERNAME\n                            For languagetool.org Premium API. Your username/email\n                            as used to log in at languagetool.org [env var:\n                            USERNAME]\n      -P, --api-key API_KEY\n                        For languagetool.org Premium API. [env var: API_KEY]\n      --pwl, --personal-word-list PWL\n                            File name of personal dictionary. A private dictionary\n                            can be used to add special words that would otherwise\n                            be marked as spelling errors. [env var:\n                            PERSONAL_WORD_LIST]\n\n    Args that start with '--' can also be set in a config file\n    (~/.config/pyLanguagetool.conf). Config file syntax allows: key=value,\n    flag=true, stuff=[a,b,c] (for details, see syntax at\n    https://pypi.org/project/ConfigArgParse/). In general, command-line values\n    override environment variables which override config file values which\n    override defaults.\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg\n    :target: https://raw.githubusercontent.com/Findus23/pyLanguagetool/master/LICENSE\n.. |latestrelease| image:: https://img.shields.io/pypi/v/pyLanguagetool.svg\n    :target: https://pypi.python.org/pypi/pyLanguagetool\n    :alt: Latest Version\n.. |pypi_versions| image:: https://img.shields.io/pypi/pyversions/pylanguagetool.svg\n    :target: https://pypi.python.org/pypi/pyLanguagetool\n\n.. _LanguageTool: https://languagetool.org/\n\n.. _JSON API: https://languagetool.org/http-api/swagger-ui/#/default\n\n.. _LanguageTool API: https://languagetool.org/http-api/swagger-ui/#/default\n\n.. _ConfigArgParse documentation: https://github.com/bw2/ConfigArgParse#config-file-syntax\n\n.. _privacy policy: https://languagetool.org/privacy/\n\n.. _set up your own server: https://dev.languagetool.org/http-server\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffindus23%2Fpylanguagetool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffindus23%2Fpylanguagetool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffindus23%2Fpylanguagetool/lists"}