diff --git a/README.md b/README.md index 07c170d46cb3..45b71c8a4824 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ Got a question? We are always happy to answer questions! Here are some good places to ask them: -- for anything you're curious about, try [gitter chat](https://gitter.im/python/typing) - for general questions about Python typing, try [typing discussions](https://github.com/python/typing/discussions) +- for anything you're curious about, try [gitter chat](https://gitter.im/python/typing) If you're just getting started, [the documentation](https://mypy.readthedocs.io/en/stable/index.html) @@ -30,7 +30,6 @@ If you think you've found a bug: - check our [common issues page](https://mypy.readthedocs.io/en/stable/common_issues.html) - search our [issue tracker](https://github.com/python/mypy/issues) to see if it's already been reported -- consider asking on [gitter chat](https://gitter.im/python/typing) To report a bug or request an enhancement: @@ -101,8 +100,6 @@ repo directly: ```bash python3 -m pip install -U git+https://github.com/python/mypy.git -# or if you don't have 'git' installed -python3 -m pip install -U https://github.com/python/mypy/zipball/master ``` Now you can type-check the [statically typed parts] of a program like this: @@ -118,14 +115,16 @@ programs, even if mypy reports type errors: python3 PROGRAM ``` -You can also try mypy in an [online playground](https://mypy-play.net/) (developed by -Yusuke Miyazaki). If you are working with large code bases, you can run mypy in +If you are working with large code bases, you can run mypy in [daemon mode], that will give much faster (often sub-second) incremental updates: ```bash dmypy run -- PROGRAM ``` +You can also try mypy in an [online playground](https://mypy-play.net/) (developed by +Yusuke Miyazaki). + [statically typed parts]: https://mypy.readthedocs.io/en/latest/getting_started.html#function-signatures-and-dynamic-vs-static-typing [daemon mode]: https://mypy.readthedocs.io/en/stable/mypy_daemon.html @@ -134,6 +133,7 @@ Integrations Mypy can be integrated into popular IDEs: +- VS Code: provides [basic integration](https://code.visualstudio.com/docs/python/linting#_mypy) with mypy. - Vim: - Using [Syntastic](https://github.com/vim-syntastic/syntastic): in `~/.vimrc` add `let g:syntastic_python_checkers=['mypy']` @@ -141,11 +141,9 @@ Mypy can be integrated into popular IDEs: or can be explicitly enabled by adding `let b:ale_linters = ['mypy']` in `~/vim/ftplugin/python.vim` - Emacs: using [Flycheck](https://github.com/flycheck/) - Sublime Text: [SublimeLinter-contrib-mypy](https://github.com/fredcallaway/SublimeLinter-contrib-mypy) -- Atom: [linter-mypy](https://atom.io/packages/linter-mypy) -- PyCharm: [mypy plugin](https://github.com/dropbox/mypy-PyCharm-plugin) (PyCharm integrates - [its own implementation](https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html) of [PEP 484](https://peps.python.org/pep-0484/)) -- VS Code: provides [basic integration](https://code.visualstudio.com/docs/python/linting#_mypy) with mypy. -- pre-commit: use [pre-commit mirrors-mypy](https://github.com/pre-commit/mirrors-mypy). +- PyCharm: [mypy plugin](https://github.com/dropbox/mypy-PyCharm-plugin) +- pre-commit: use [pre-commit mirrors-mypy](https://github.com/pre-commit/mirrors-mypy), although + note by default this will limit mypy's ability to analyse your third party dependencies. Web site and documentation -------------------------- @@ -171,8 +169,6 @@ contributors of all experience levels. To get started with developing mypy, see [CONTRIBUTING.md](CONTRIBUTING.md). -If you need help getting started, don't hesitate to ask on [gitter](https://gitter.im/python/typing). - Mypyc and compiled version of mypy ---------------------------------- @@ -190,4 +186,4 @@ To use a compiled version of a development version of mypy, directly install a binary from . -To contribute to the mypyc project, check out +To contribute to the mypyc project, check out the issue tracker at