Setup Guide¶

Tach is primarily written in rust, but since it's purpose is to be used by python developers, we've made the setup process as simple as possible by making the rust compiler and other similar tools pinned as pypi dev dependencies using uv. This project also uses pyprojectx to manage its uv installation, so you should be able to get set up for local development as long as you have a python interpreter installed already.

1. Automated setup¶

Installing all the dependencies & build the project

./pw uv sync

2. Test¶

Tach internally uses pytest module for testing all the files within python/tests/

make test

3. Setting up the docs¶

Tach uses MkDocs with the Material theme for documentation. To work with the documentation:

Start the local development server:
```
mkdocs serve
```
Open your browser to http://127.0.0.1:8000/ to see the documentation.

For more details, see Working with Docs.

5. Things to check before committing¶

Check and sync your dependencies in the root folder

tach check
tach sync

Type checking

make type-check

Run linting checks for Rust and Python code

make lint

Format Rust and Python code

make fmt

That's it! You are now ready to push your new dev branch to your forked repo and then raise a PR with appropriate description

Find Beginner Friendly issues here: - Good First Issues (For beginners) - Documentation Issues - Issues - Documentation