Go to file
Jack O'Connor ad82b625e1 Codex is right 2025-11-25 13:22:36 -08:00
.github Update actions/checkout digest to `1af3b93b6815bc44a9784bd300feb67ff0d1eeb3` (#1615) 2025-11-24 07:53:11 +00:00
assets/badge `ty` badge (#897) 2025-07-28 20:35:08 +01:00
docs Small documentation improvements (#1606) 2025-11-21 10:24:10 +01:00
python/ty add `py.typed` (#276) 2025-05-08 09:00:10 -07:00
ruff@62343a101a Bump version to 0.0.1a27 (#1586) 2025-11-18 19:56:46 +00:00
scripts Codex is right 2025-11-25 13:22:36 -08:00
.editorconfig Move TOML indent size config (#251) 2025-05-07 18:13:32 +00:00
.gitattributes [CI] Add check for changes in autogenerated files (#415) 2025-05-16 08:05:04 +02:00
.gitignore Initial commit 2025-05-02 11:37:31 -05:00
.gitmodules Add `ruff` as a submodule 2025-05-02 11:41:08 -05:00
.markdownlint.yaml Update pre-commit dependencies (#809) 2025-07-11 07:59:44 +00:00
.pre-commit-config.yaml Update pre-commit dependencies (#1618) 2025-11-24 01:30:30 +00:00
.python-version Commit the `uv.lock` and `.python-version` files (#61) 2025-05-06 09:45:39 -05:00
CHANGELOG.md Bump version to 0.0.1a27 (#1586) 2025-11-18 19:56:46 +00:00
CODE_OF_CONDUCT.md Update email in code of conduct (#55) 2025-05-06 08:32:29 +02:00
CONTRIBUTING.md Minor adjustment to release instructions (#1372) 2025-10-16 20:10:25 +02:00
Dockerfile Enable Docker build workflow (#38) 2025-05-05 15:48:32 -05:00
LICENSE Drop `-MIT` suffix from license file (#26) 2025-05-05 08:31:14 -05:00
README.md Small documentation improvements (#1606) 2025-11-21 10:24:10 +01:00
SECURITY.md Add SECURITY.md (#23) 2025-05-05 15:18:41 +02:00
_typos.toml Bump version to 0.0.1-alpha.21 (#1205) 2025-09-19 08:42:23 +02:00
dist-workspace.toml Update actions/checkout digest to `1af3b93b6815bc44a9784bd300feb67ff0d1eeb3` (#1615) 2025-11-24 07:53:11 +00:00
mkdocs.insiders.yml Copy basic template and styling for documentation from uv (#729) 2025-07-02 09:40:49 -05:00
mkdocs.public.yml Copy basic template and styling for documentation from uv (#729) 2025-07-02 09:40:49 -05:00
mkdocs.template.yml Sync env.md script in release pipeline (#782) 2025-07-08 11:34:51 -04:00
pyproject.toml Bump version to 0.0.1a27 (#1586) 2025-11-18 19:56:46 +00:00
uv.lock Bump version to 0.0.1a27 (#1586) 2025-11-18 19:56:46 +00:00

README.md

ty

ty PyPI Discord

An extremely fast Python type checker and language server, written in Rust.

Getting started

Try out the online playground, or run ty with uvx to get started quickly:

uvx ty

For other ways to install ty, see the installation documentation.

If you do not provide a subcommand, ty will list available commands — for detailed information about command-line options, see the CLI reference.

Use the check command to run the type checker:

uvx ty check

ty will run on all Python files in the working directory and or subdirectories. If used from a project, ty will run on all Python files in the project (starting in the directory with the pyproject.toml)

You can also provide specific paths to check:

uvx ty check example.py

When type checking, ty will find installed packages in the active virtual environment (via VIRTUAL_ENV) or discover a virtual environment named .venv in the project root or working directory. It will not find packages in non-virtual environments without specifying the target path with --python. See the module discovery documentation for details.

Learning more

To learn more about using ty, see the documentation.

Getting involved

If you have questions or want to report a bug, please open an issue in this repository.

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.

License

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.