Welcome to darca-git’s documentation!

Welcome to the developer and user documentation for darca-git, the Git CLI abstraction layer built for the Darca ecosystem.

Project Overview

Darca Git

Darca Git is a lightweight abstraction over Git CLI commands, built to integrate with darca-executor and the Darca ecosystem.

• 🔐 Runs shell-safe commands via darca-executor

• 🧪 100% tested with pytest

• 🧰 Integrated with darca-space-git for space-aware Git

Installation

Clone and install the project using:

make install

Usage

from darca_git.git import Git

git = Git()
git.init("/your/repo")
git.status("/your/repo")

Testing

Run tests with full coverage:

make test

Documentation

Docs are built with Sphinx:

make docs

Pre-commit Hooks

Check formatting, linting and more with:

make precommit

Full quality check:

make check

Getting Started

Contents

• Usage Guide
  • Installation
  • Basic Git Operations
  • Dry Run Mode
  • Running Tests
• API Docs
  • Git
  • GitException

Community & Contribution

Contributing Guidelines

We welcome contributions to darca-git — from bug fixes to features and docs!

Workflow

1. Fork the repository

2. Create a feature branch:

   git checkout -b feature/your-feature
   

3. Install dependencies:

   make install
   

4. Make your changes and run:

   make check
   

5. Push your branch and open a Pull Request.

Branch Naming

• feature/your-feature for features

• fix/your-bug for bug fixes

• docs/your-doc-change for docs

Pull Requests

All PRs must:

• Pass make check (format, tests, docs)

• Include meaningful tests if applicable

• Follow project style (PEP8 via black and isort)

Tips

• Use make targets to automate tasks

• Use make debug to inspect your local setup

• Ask questions, open discussions — we’re happy to help!