README.md
An extremely fast Python type checker and language server, written in Rust.
<p align="center"> </p> <p align="center"> <i>Type checking the <a href="https://github.com/home-assistant/core">home-assistant</a> project without caching.</i> </p>ty is backed by Astral, the creators of uv and Ruff.
ty is currently in beta.
Run ty with uvx to get started quickly:
uvx ty check
Or, check out the ty playground to try it out in your browser.
To learn more about using ty, see the documentation.
To install ty, see the installation documentation.
To add the ty language server to your editor, see the editor integration guide.
If you have questions or want to report a bug, please open an issue in this repository.
You may also join our Discord server.
Development of this project takes place in the Ruff repository
at this time. Please open pull requests there for changes
to anything in the ruff submodule (which includes all of the Rust source code).
See the contributing guide for more details.
ty uses 0.0.x versioning. ty does not yet have a stable API; breaking changes, including changes
to diagnostics, may occur between any two versions. See the type system support
tracking issue for a detailed overview of currently supported features.
See our typing FAQ.
It's pronounced as "tee - why" (/tiː waɪ/)
Just "ty", please.
<!-- markdownlint-enable MD001 -->ty is licensed under the MIT license (LICENSE or https://opensource.org/licenses/MIT).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ty by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.
<div align="center"> <a target="_blank" href="https://astral.sh" style="background:none"> </a> </div>