Metadata-Version: 2.1
Name: mypy-ls
Version: 0.4.1
Summary: Mypy linter for the Python LSP Server
Home-page: https://github.com/Richardk2n/pyls-mypy
Author: Tom van Ommeren, Richard Kellnberger
License: 'MIT'
Description: Mypy plugin for PYLS
        ======================
        
        .. image:: https://badge.fury.io/py/mypy-ls.svg
            :target: https://badge.fury.io/py/mypy-ls
        
        .. image:: https://github.com/Richardk2n/pyls-mypy/workflows/Python%20package/badge.svg?branch=master
            :target: https://github.com/Richardk2n/pyls-mypy/
        
        This is a plugin for the `Python LSP Server`_.
        
        .. _`Python LSP Server`: https://github.com/python-lsp/python-lsp-server
        
        It, like mypy, requires Python 3.6 or newer.
        
        
        Installation
        ------------
        
        Install into the same virtualenv as python-lsp-server itself.
        
        ``pip install mypy-ls``
        
        Configuration
        -------------
        
        ``live_mode`` (default is True) provides type checking as you type.
            This writes to a tempfile every time a check is done. Turning off ``live_mode`` means you must save your changes for mypy diagnostics to update correctly.
        
        ``dmypy`` (default is False) executes via ``dmypy run`` rather than ``mypy``.
            This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
        
        ``strict`` (default is False) refers to the ``strict`` option of ``mypy``.
            This option often is too strict to be useful.
        
        Depending on your editor, the configuration (found in a file called mypy-ls.cfg in your workspace or a parent directory) should be roughly like this for a standard configuration:
        
        ::
        
            {
                "enabled": True,
                "live_mode": True,
                "strict": False
            }
        
        With ``dmypy`` enabled your config should look like this:
        
        ::
        
            {
                "enabled": True,
                "live_mode": False,
                "dmypy": True,
                "strict": False
            }
        
        Developing
        -------------
        
        Install development dependencies with (you might want to create a virtualenv first):
        
        ::
        
           pip install -r requirements.txt
        
        The project is formatted with `black`_. You can either configure your IDE to automatically format code with it, run it manually (``black .``) or rely on pre-commit (see below) to format files on git commit.
        
        The project uses two rst tests in order to assure uploadability to pypi: `rst-linter`_ as a pre-commit hook and `rstcheck`_ in a GitHub workflow. This does not catch all errors.
        
        This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
        
        ::
        
           pre-commit install
        
        After that pre-commit will run `all defined hooks`_ on every ``git commit`` and keep you from committing if there are any errors.
        
        .. _black: https://github.com/psf/black
        .. _rst-linter: https://github.com/Lucas-C/pre-commit-hooks-markup
        .. _rstcheck: https://github.com/myint/rstcheck
        .. _pre-commit: https://pre-commit.com/
        .. _all defined hooks: .pre-commit-config.yaml
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: test
