ties 0.0.0a6

A CLI tool to duplicate and sync file content with advanced transformations.

Ties 🔗

A powerful CLI tool to duplicate and sync file content with advanced transformations. Keep your repository files in sync automatically with intelligent content synchronization.

✨ Features

• File Synchronization: Automatically keep multiple files in sync across your repository
• Advanced Transformations: Apply custom transformations during file copying
• Pre-commit Integration: Enforce file consistency as part of your development workflow
• Configuration-Driven: Simple TOML-based configuration
• Environment Variable Support: Embed environment variables in target files
• Cross-Platform: Works on Windows, macOS, and Linux

🚀 Quick Start

Installation

# Install from PyPI
pip install ties

# Or install with YAML support
pip install ties[yaml]

# Or install from source
git clone https://github.com/AlonKellner/ties.git
cd ties
pip install -e .

Basic Usage

1. Create a configuration in your pyproject.toml:

[tool.ties]
[[tool.ties.tie]]
name = "gitignore sync"
source = ".gitignore"
target = "examples/.gitignore"

2. Check for discrepancies:

ties check

3. Fix discrepancies automatically:

ties fix

Advanced Configuration

[tool.ties]
[[tool.ties.tie]]
name = "Environment Config"
source = ".ties/config.template"
targets = [".env.local", ".env.production"]
transform = "ties:embed_environ"

[[tool.ties.tie]]
name = "Documentation Sync"
source = "README.md"
target = "docs/README.md"
transform = "transform:markdown_cleanup"

📖 Documentation

• User Guide - Complete usage instructions
• Configuration Reference - All configuration options
• Transformations - Available transformation functions
• Examples - Common use cases and examples

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

# Clone the repository
git clone https://github.com/AlonKellner/ties.git
cd ties

# Create virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
uv pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with modern Python tooling (uv, ruff, pytest)
• CI/CD powered by GitHub Actions
• Security scanning with Trivy

📊 Project Status

• Development Status: Alpha (3)
• Python Support: 3.10+
• License: MIT
• Maintainer: Alon Kellner

---

Made with ❤️ by the Ties community