Metadata-Version: 2.1
Name: pyLanguagetool
Version: 0.8.3
Summary: A python library and CLI for the LanguageTool JSON API
Home-page: https://pylanguagetool.lw1.at/
Author: Lukas Winkler
Author-email: python@lw1.at
License: MIT
Description: ==============
        pyLanguagetool
        ==============
        |travis| |license| |latestrelease| |pypi_versions|
        
        A python library and CLI for the LanguageTool_ `JSON API`_.
        
        LanguageTool_ is an open source spellchecking platform. It supports a large
        variety of languages and has advanced grammar support.
        
        .. image:: https://pylanguagetool.lw1.at/_images/screenshot.png
        
        .. start-of-homepage-text
        
        **Warning:** The first release in 2020 will drop Python 2 support.
        
        Installation
        ------------
        pyLanguagetool can be installed with pip/pipenv:
        
        .. code:: bash
        
            pip install pylanguagetool
            # or via pipenv
            pipenv install pylanguagetool
        
        Basic Usage
        -----------
        .. code:: bash
        
            # pipe text to pylanguagetool
            echo "This is a example" | pylanguagetool
        
            # read text from a file
            pylanguagetool textfile.txt
        
            # read text from stdin
            pylanguagetool < textfile.txt
        
            # read text from the systems clipboard
            pylanguagetool -c # get text from system clipboard
        
        All samples above will return a list of detected errors and possible
        replacements.
        
        .. code::
        
            # Use "an" instead of 'a' if the following word starts with a vowel sound, e.g. 'an article', 'an hour'
            #   ✗ This is a example
            #             ^
            #   ✓ This is an example
        
        
        
        Configuration
        -------------
        All `LanguageTool API`_ parameters can be set via command line arguments,
        environment variables or a configuration file
        (``~/.config/pyLanguagetool.conf``) For more information about the
        configuration file syntax, read the `ConfigArgParse documentation`_.
        
        Parameters
        ----------
        
        .. code::
        
            $ pylanguagetool --help
            usage: pylanguagetool [-h] [-v] [-a API_URL] [--no-color] [-c] [-s]
                                  [-t {txt,html,md,rst,ipynb}] [-l LANG]
                                  [-m MOTHER_TONGUE] [-p PREFERRED_VARIANTS]
                                  [-e ENABLED_RULES] [-d DISABLED_RULES]
                                  [--enabled-categories ENABLED_CATEGORIES]
                                  [--disabled-categories DISABLED_CATEGORIES]
                                  [--enabled-only] [--pwl PWL]
                                  [input file]
        
            Args that start with '--' (eg. -v) can also be set in a config file
            (~/.config/pyLanguagetool.conf). Config file syntax allows: key=value,
            flag=true, stuff=[a,b,c] (for details, see syntax at
            https://pypi.org/project/ConfigArgParse/). If an arg is specified in more than
            one place, then commandline values override environment variables which
            override config file values which override defaults.
        
            positional arguments:
              input file            input file
        
            optional arguments:
              -h, --help            show this help message and exit
              -v, --verbose         [env var: VERBOSE]
              -a API_URL, --api-url API_URL
                                    the URL of the v2 languagetool API, should end with
                                    '/v2/' [env var: API_URL]
              --no-color            don't color output [env var: NO_COLOR]
              -c, --clipboard       get text from system clipboard [env var: CLIPBOARD]
              -s, --single-line     check every line on its own [env var: SINGLE_LINE]
              -t {txt,html,md,rst,ipynb}, --input-type {txt,html,md,rst,ipynb}
                                    if not plaintext [env var: CLIPBOARD]
              -r, --rules           show the matching rules [env var: RULES]
              --rule-categories     show the the categories of the matching rules [env
                                    var: RULE_CATEGORIES]
              -l LANG, --lang LANG  A language code like en or en-US, or auto to guess the
                                    language automatically (see preferredVariants below).
                                    For languages with variants (English, German,
                                    Portuguese) spell checking will only be activated when
                                    you specify the variant, e.g. en-GB instead of just
                                    en. [env var: TEXTLANG]
              -m MOTHER_TONGUE, --mother-tongue MOTHER_TONGUE
                                    A language code of the user's native language,
                                    enabling false friends checks for some language pairs.
                                    [env var: MOTHER__TONGUE]
              -p PREFERRED_VARIANTS, --preferred-variants PREFERRED_VARIANTS
                                    Comma-separated list of preferred language variants.
                                    The language detector used with language=auto can
                                    detect e.g. English, but it cannot decide whether
                                    British English or American English is used. Thus this
                                    parameter can be used to specify the preferred
                                    variants like en-GB and de-AT. Only available with
                                    language=auto. [env var: PREFERRED_VARIANTS]
              -e ENABLED_RULES, --enabled-rules ENABLED_RULES
                                    IDs of rules to be enabled, comma-separated [env var:
                                    ENABLED_RULES]
              -d DISABLED_RULES, --disabled-rules DISABLED_RULES
                                    IDs of rules to be disabled, comma-separated [env var:
                                    DISABLED_RULES]
              --enabled-categories ENABLED_CATEGORIES
                                    IDs of categories to be enabled, comma-separated [env
                                    var: ENABLED_CATEGORIES]
              --disabled-categories DISABLED_CATEGORIES
                                    IDs of categories to be disabled, comma-separated [env
                                    var: DISABLED_CATEGORIES]
              --enabled-only        enable only the rules and categories whose IDs are
                                    specified with --enabled-rules or --enabled-categories
        
              --pwl PWL, --personal-word-list PWL
                                    File name of personal dictionary. A private dictionary
                                    can be used to add special words that would otherwise
                                    be marked as spelling errors. [env var:
                                    PERSONAL_WORD_LIST]
        
        
        
        .. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
            :target: https://raw.githubusercontent.com/Findus23/pyLanguagetool/master/LICENSE
        .. |latestrelease| image:: https://img.shields.io/pypi/v/pyLanguagetool.svg
            :target: https://pypi.python.org/pypi/pyLanguagetool
            :alt: Latest Version
        .. |travis| image:: https://img.shields.io/travis/Findus23/pyLanguagetool.svg
            :target: https://travis-ci.org/Findus23/pyLanguagetool
        .. |pypi_versions| image:: https://img.shields.io/pypi/pyversions/pylanguagetool.svg
            :target: https://pypi.python.org/pypi/pyLanguagetool
        
        Privacy
        -------
        
        By default, pyLanguagetool sends all text via HTTPS to the `LanguageTool`_
        server (see their `privacy policy`_). You can also `setup your own server`_ and
        use it by changing the ``--api-url`` attribute.
        
        .. _LanguageTool: https://languagetool.org/
        
        .. _JSON API: https://languagetool.org/http-api/swagger-ui/#/default
        
        .. _LanguageTool API: https://languagetool.org/http-api/swagger-ui/#/default
        
        .. _ConfigArgParse documentation: https://github.com/bw2/ConfigArgParse#config-file-syntax
        
        .. _privacy policy: https://languagetool.org/privacy/
        
        .. _setup your own server: http://wiki.languagetool.org/http-server
        
Keywords: languagetool spell grammar checker
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Text Processing :: Linguistic
Provides-Extra: optional
Provides-Extra: dev
