Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gauge-sh/tach
Tach - a Python framework for your modular monorepo - cli with bash and terminal support 🌎 Open-source 🐍 Installable via pip 🦀 Written in rust 🔒 Maintain code quality 🔧 Works through static parsing of your code ⚡ Maintain productivity ♾️ git pre-commit and VS Code extension 👨💻 built by Gauge
https://github.com/gauge-sh/tach
awesome ci cli code-quality config continu dependency-management developer-tools devops framework library monorepo open-source package productivity programming rust static-code-analysis terminal
Last synced: 2 months ago
JSON representation
Tach - a Python framework for your modular monorepo - cli with bash and terminal support 🌎 Open-source 🐍 Installable via pip 🦀 Written in rust 🔒 Maintain code quality 🔧 Works through static parsing of your code ⚡ Maintain productivity ♾️ git pre-commit and VS Code extension 👨💻 built by Gauge
- Host: GitHub
- URL: https://github.com/gauge-sh/tach
- Owner: gauge-sh
- License: gpl-3.0
- Created: 2024-01-31T20:12:23.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-11T01:03:57.000Z (6 months ago)
- Last Synced: 2024-06-11T01:54:37.215Z (6 months ago)
- Topics: awesome, ci, cli, code-quality, config, continu, dependency-management, developer-tools, devops, framework, library, monorepo, open-source, package, productivity, programming, rust, static-code-analysis, terminal
- Language: Python
- Homepage: https://gauge-sh.github.io/python-modular-monorepo-framework-tool/
- Size: 19 MB
- Stars: 340
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tach
[](https://pepy.tech/project/tach)
[](https://pypi.Python.org/pypi/tach)
[](https://pypi.Python.org/pypi/tach)
[](https://pypi.Python.org/pypi/tach)
[](https://github.com/gauge-sh/tach/actions/workflows/ci.yml)
[](https://microsoft.github.io/pyright/)
[](https://github.com/astral-sh/ruff)
a Python tool to enforce dependencies, written in Rust. Inspired by modular monolithic architecture.
[Docs](https://docs.gauge.sh)
[Discord](https://discord.gg/Kz2TnszerR)
Tach lets you define and enforce dependencies between Python modules within your project.
Here's an example:
If a module tries to import from another module that is not listed as a dependency, Tach can prevent it.
Tach is:
- 🌎 Open source
- 🐍 Installable via pip
- 🔧 Able to be adopted incrementally
- ⚡ Implemented with no runtime impact
- ♾️ Interoperable with your existing systems (cli, hooks, ci, etc.)
## Getting Started
### Installation
```bash
pip install tach
```
### Setup
Tach allows you to configure where you want to place module boundaries in your project.
You can do this interactively - run:
```bash
tach mod
# Up/Down: Navigate Enter: Mark/unmark module Right: Expand Left: Collapse Ctrl + Up: Jump to parent
# Ctrl + s: Exit and save Ctrl + c: Exit without saving Ctrl + a: Mark/unmark all
```
Mark each module boundary with 'Enter'. You can mark all of your top-level Python source packages, or just a few which you want to isolate.
If your Python code lives below your project root, or if you are working in a monorepo with multiple Python packages, mark your Python [source roots](https://docs.gauge.sh/usage/configuration#source-roots) using the 's' key.
This will create the config file for your project, `tach.toml`.
Once you've marked all the modules you want to enforce dependencies between, run:
```bash
tach sync
```
Dependencies that exist between each module you've marked will be written to `tach.toml`.
Check out what Tach has found!
```
cat tach.toml
```
Note: Your [source roots](https://docs.gauge.sh/usage/configuration#source-roots) will implicitly be treated as module boundaries, and can show up as ``.
### Enforcement
Tach comes with a cli command to enforce the boundaries that you just set up! From the root of your Python project, run:
```bash
tach check
```
You will see:
```bash
✅ All module dependencies validated!
```
You can validate that Tach is working by either:
1. Commenting out an item in a `depends_on` key in `tach.toml`
2. By adding an import between modules that didn't previously import from each other.
Give both a try and run `tach check` again. This will generate an error:
```bash
❌ tach/check.py[L8]: Cannot import 'tach.filesystem'. Module 'tach' cannot depend on 'tach.filesystem'.
```
Each error indicates an import which violates your dependencies. If your terminal supports hyperlinks, click on the file path to go directly to the error.
When an error is detected, `tach check` will exit with a non-zero code. It can be easily integrated with CI/CD, [Pre-commit hooks](https://docs.gauge.sh/usage/commands#tach-install), and [VS Code](https://marketplace.visualstudio.com/items?itemName=Gauge.tach), and more!
### Extras
Visualize your dependency graph.
```bash
tach show [--web]
```
Tach will generate a graph of your dependencies. Here's what this looks like for Tach:
Note that this graph is generated remotely with the contents of your `tach.toml` when running `tach show --web`.
If you would like to use the [GraphViz DOT format](https://graphviz.org/about/) locally, simply running `tach show` will generate `tach_module_graph.dot` in your working directory.
You can view the dependencies and usages for a given path:
```bash
tach report my_package/
# OR
tach report my_module.py
```
e.g.:
```bash
> tach report python/tach/filesystem
[Dependencies of 'python/tach/filesystem']
python/tach/filesystem/install.py[L6]: Import 'tach.hooks.build_pre_commit_hook_content'
python/tach/filesystem/project.py[L5]: Import 'tach.constants.CONFIG_FILE_NAME'
...
-------------------------------
[Usages of 'python/tach/filesystem']
python/tach/cache/access.py[L8]: Import 'tach.filesystem.find_project_config_root'
python/tach/cache/setup.py[L7]: Import 'tach.filesystem.find_project_config_root'
...
```
Tach also supports:
- [Strict public interfaces for modules](https://docs.gauge.sh/usage/strict-mode/)
- [Deprecating individual dependencies](https://docs.gauge.sh/usage/deprecate)
- [Manual file configuration](https://docs.gauge.sh/usage/configuration)
- [Monorepos and namespace packages](https://docs.gauge.sh/usage/configuration#source-roots)
- [Inline exceptions](https://docs.gauge.sh/usage/tach-ignore)
- [Pre-commit hooks](https://docs.gauge.sh/usage/commands#tach-install)
More info in the [docs](https://docs.gauge.sh/). Tach logs anonymized usage statistics which can be [opted out](https://docs.gauge.sh/usage/faq/) of.
If you have any feedback, we'd love to talk!
If you have any questions or run into any issues, let us know by either reaching out on [Discord](https://discord.gg/Kz2TnszerR) or submitting a [Github Issue](https://github.com/gauge-sh/tach/issues)!
---
### Contributors
