commitflow 1.0.0__py3-none-any.whl

commitflow-1.0.0.dist-info/METADATA

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: commitflow
+Version: 1.0.0
+Summary: CLI tool for maintaining consistent Git commits automatically
+Author: Abhinav Kumar Singh
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# CommitFlow
+
+![Python](https://img.shields.io/badge/python-3.9%2B-blue)
+![License](https://img.shields.io/github/license/abhinav9444/commitflow)
+![Tests](https://img.shields.io/github/actions/workflow/status/abhinav9444/commitflow/tests.yml)
+<!--
+![PyPI](https://img.shields.io/pypi/v/commitflow)
+
+-->
+CommitFlow is a lightweight command-line tool that helps developers maintain consistent Git commits automatically without interrupting their workflow .
+It provides a simple interface to commit progress, automate daily commits and keep your GitHub contribution graph active while you focus on actual development.
+
+## Why CommitFlow?
+> ### CommitFlow is built to simplify a common developer habit: committing progress regularly.
+Developers often forget to commit progress regularly while working across multiple projects. CommitFlow simplifies this by providing a clean command-line workflow that helps automate and manage daily commits. It is designed to be simple, practical and useful for everyday development workflows.
+> ### If this tool helps your workflow, feel free to star the repository ! It means a lot !!
+
+## Features
+- Automatic repository detection
+- Commit preview before committing
+- Interactive commit workflow
+- Quick commit mode for frequent commits
+- Automatic daily commits (Scheduled runs)
+- Windows Task Scheduler support
+- Linux cron support
+- Configuration file support
+- Logging system
+- Cross-platform terminal color support
+
+<!--
+## Usage
+commitflow
+commitflow --quick
+commitflow --auto
+commitflow --setup
+commitflow --schedule
+---
+-->
+## Installation
+Install CommitFlow directly from PyPI:
+```bash
+pip install commitflow
+```
+Verify installation:
+```bash
+commitflow --version
+```
+## Quick Start
+Run CommitFlow in interactive mode. This mode guides you through the commit process step by step.
+```bash
+commitflow
+```
+You will be prompted for:
+- repository path
+- files to add
+- commit message
+- push confirmation
+
+CommitFlow shows a preview before committing.
+
+## CLI Commands
+### Interactive Mode (Default)
+Run the standard interactive workflow:
+```bash
+commitflow
+```
+
+### Quick Mode
+Use repository settings from your configuration file.
+``` bash
+commitflow --quick
+```
+Quick mode skips repository selection and speeds up the commit process.
+
+### Auto Mode
+Fully automatic commit process:
+``` bash
+commitflow --auto
+```
+This mode:
+- adds files automatically
+- commits with a default message
+- optionally pushes to remote
+
+Auto mode is mainly used by schedulers.
+
+### Setup Wizard
+Run the configuration wizard:
+``` bash
+commitflow --setup
+```
+The setup wizard asks for:
+- repository path
+- automatic push preference
+- default commit message
+- daily schedule time
+
+It can also configure the system scheduler automatically.
+
+### Scheduler Setup
+Create an automated daily commit task:
+```bash
+commitflow --schedule
+```
+CommitFlow supports:
+- Windows Task Scheduler
+- Linux/macOS cron
+
+Scheduler settings such as power conditions and retry behavior can be customized during setup.
+
+### Example Workflow
+Typical setup:
+``` bash
+commitflow --setup
+```
+After configuration, CommitFlow can run automatic commits daily.
+
+Manual commits can also be executed anytime:
+``` bash
+commitflow --quick
+```
+### Configuration File
+CommitFlow stores configuration in:
+``` bash
+~/.commitflow_config.json
+```
+Example configuration:
+```bash
+{
+  "repo": "/projects/my-project",
+  "auto_push": true,
+  "auto_add": ".",
+  "commit_message": "daily progress update"
+}
+```
+### Logs
+CommitFlow keeps logs for debugging and activity tracking.
+Default log location:
+``` bash
+~/.commitflow.log
+```
+Log entries include:
+- commit operations
+- warnings
+- errors
+- scheduler events
+
+### Supported Platforms
+- Windows
+- Linux
+<!--
+Schedulers supported:
+- Windows Task Scheduler
+- cron
+-->
+<!--
+Running Tests
+
+Install development dependencies:
+
+pip install pytest
+
+Run tests:
+
+pytest
+
+GitHub Actions automatically runs tests on each push.
+
+Project Structure
+commitflow
+│
+├── daily_git_assistant
+│   ├── main.py
+│   ├── config.py
+│   ├── git_utils.py
+│   ├── logger.py
+│   ├── repo_scanner.py
+│   ├── scheduler.py
+│   ├── ui.py
+│   └── modes
+│
+├── tests
+├── setup.py
+└── README.md
+-->
+
+### Contributing
+Contributions are welcome. If you would like to improve CommitFlow:
+- Fork the repository
+- Create a feature branch
+- Submit a pull request
+
+Bug reports and feature suggestions are appreciated.
+
+### License
+This project is licensed under the MIT License.
+
+### Author
+Abhinav Kumar Singh

commitflow-1.0.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+commitflow-1.0.0.dist-info/licenses/LICENSE,sha256=xc-pONOWUH4mK8fw4GjVCS3-4_PvclWW0gsrFOVsPcA,1097
+daily_git_assistant/__init__.py,sha256=Aj77VL1d5Mdku7sgCgKQmPuYavPpAHuZuJcy6bygQZE,21
+daily_git_assistant/config.py,sha256=Nn1FTVziG9eZM4vAnxCPW9E0Hi_RZOUrwn3Wpxcv3Oc,2543
+daily_git_assistant/git_utils.py,sha256=_5hMXH12qpdJDC-z5Dju39X4necC5do5pHfcXvzNJi8,3177
+daily_git_assistant/logger.py,sha256=xVmf-e1FFs4eMCXu4ZR1IE1RB322uvdLtMfKGS_CGIk,1997
+daily_git_assistant/main.py,sha256=tR1huAl0EFe4Jb5ZoK3gFqHcPl1VKYhSIalQ0RBKs0M,2127
+daily_git_assistant/repo_scanner.py,sha256=ad4wXWPcmLmxzPBfOx4ProYu2I0EPqYrihIHiYUy-hU,2581
+daily_git_assistant/scheduler.py,sha256=yipEOEoUbuIjLW2eh6SjrOzE3XXlxyAVu9FC-OIdX2Y,6590
+daily_git_assistant/ui.py,sha256=6KdOQcUa1XfpvbYCYpPDiPpVyAgs9bf0GrEDDgS0WAU,3383
+daily_git_assistant/modes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+daily_git_assistant/modes/auto.py,sha256=qn0z8U14HsrIev_Uw_uaBf_Fr4c1OxtLnX8lZEFPgM8,2650
+daily_git_assistant/modes/interactive.py,sha256=zv1ADexjpnJQjhARJavmAfyfNpDwKfJ8iYXhMZi4hls,3759
+daily_git_assistant/modes/quick.py,sha256=Fli3U4iKPvRarTrlAk0zL8BSrex0-UxKHq6ZtmCuaRw,2961
+daily_git_assistant/modes/setup.py,sha256=02Fs3h9z78I0KvvIXuhHKlq5Px3b4EiSrt4ZpFnaEdk,2214
+commitflow-1.0.0.dist-info/METADATA,sha256=BiJJlNTrF6QjHF8bsnrj9TSg-Dk3REopclefAeQRcbA,5208
+commitflow-1.0.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+commitflow-1.0.0.dist-info/entry_points.txt,sha256=XnAqmSVYYmxDwOR9m3KIoisLIMBpl7i97FLQd_dWMvc,61
+commitflow-1.0.0.dist-info/top_level.txt,sha256=1hLlmrsma5OW_nRh4oaaAjf3DFK1837HWHU0FlL0HMw,20
+commitflow-1.0.0.dist-info/RECORD,,

commitflow-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

commitflow-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+commitflow = daily_git_assistant.main:main

commitflow-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Abhinav Kumar Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

commitflow-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+daily_git_assistant

daily_git_assistant/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

daily_git_assistant/config.py

@@ -0,0 +1,126 @@
+import os
+import json
+from pathlib import Path
+
+# Default config file location
+CONFIG_PATH = os.path.join(Path.home(), ".commitflow_config.json")
+
+# Default configuration values
+DEFAULT_CONFIG = {
+    "repo": "",
+    "auto_push": False,
+    "auto_add": ".",
+    "commit_message": "Daily progress update",
+    "schedule_time": "21:00"
+}
+
+
+def create_default_config():
+    """
+    Create a config file with default values if it does not exist.
+    """
+    if not os.path.exists(CONFIG_PATH):
+        try:
+            with open(CONFIG_PATH, "w") as f:
+                json.dump(DEFAULT_CONFIG, f, indent=4)
+
+            return DEFAULT_CONFIG
+
+        except Exception as e:
+            raise RuntimeError(f"Failed to create config file: {e}")
+
+    return load_config()
+
+
+def load_config():
+    """
+    Load configuration from config file.
+    """
+    try:
+        with open(CONFIG_PATH, "r") as f:
+            config = json.load(f)
+
+        return config
+
+    except FileNotFoundError:
+
+        return create_default_config()
+
+    except json.JSONDecodeError:
+
+        raise RuntimeError(
+            "Config file corrupted. Delete ~/.commitflow_config.json and run setup again."
+        )
+
+
+def save_config(config_data):
+    """
+    Save updated configuration.
+    """
+
+    try:
+
+        with open(CONFIG_PATH, "w") as f:
+            json.dump(config_data, f, indent=4)
+
+    except Exception as e:
+
+        raise RuntimeError(f"Failed to save config: {e}")
+
+
+def update_config(key, value):
+    """
+    Update a single configuration field.
+    """
+
+    config = load_config()
+
+    config[key] = value
+
+    save_config(config)
+
+
+def validate_repo_path(repo_path):
+    """
+    Ensure repository path exists and is valid.
+    """
+
+    if not repo_path:
+        raise ValueError("Repository path not set in config")
+
+    if not os.path.exists(repo_path):
+        raise ValueError(f"Repository path does not exist: {repo_path}")
+
+    return True
+
+
+def get_repo():
+    """
+    Retrieve repository path from config.
+    """
+
+    config = load_config()
+
+    repo = config.get("repo", "")
+
+    validate_repo_path(repo)
+
+    return repo
+
+
+def reset_config():
+    """
+    Reset configuration to default values.
+    """
+
+    try:
+
+        with open(CONFIG_PATH, "w") as f:
+
+            json.dump(DEFAULT_CONFIG, f, indent=4)
+
+        return True
+
+    except Exception as e:
+
+        raise RuntimeError(f"Failed to reset config: {e}")

daily_git_assistant/git_utils.py

@@ -0,0 +1,165 @@
+import os
+import subprocess
+
+
+def run_git_command(cmd, repo_path):
+    """
+    Execute a git command safely.
+    """
+
+    try:
+
+        result = subprocess.run(
+            cmd,
+            cwd=repo_path,
+            capture_output=True,
+            text=True
+        )
+
+        return result
+
+    except Exception as e:
+
+        raise RuntimeError(f"Git command failed: {e}")
+
+
+def is_git_repo(repo_path):
+    """
+    Validate whether a directory is a git repository.
+    """
+
+    if not os.path.exists(repo_path):
+        return False
+
+    result = run_git_command(["git", "rev-parse", "--is-inside-work-tree"], repo_path)
+
+    return result.returncode == 0
+
+
+def get_repo_name(repo_path):
+    """
+    Get repository folder name.
+    """
+
+    return os.path.basename(os.path.abspath(repo_path))
+
+
+def get_branch(repo_path):
+    """
+    Get current git branch.
+    """
+
+    result = run_git_command(["git", "branch", "--show-current"], repo_path)
+
+    if result.returncode != 0:
+        return "unknown"
+
+    return result.stdout.strip()
+
+
+def get_remote_url(repo_path):
+    """
+    Retrieve repository remote URL.
+    """
+
+    result = run_git_command(
+        ["git", "config", "--get", "remote.origin.url"],
+        repo_path
+    )
+
+    if result.returncode != 0:
+        return "unknown"
+
+    return result.stdout.strip()
+
+
+def get_status(repo_path):
+    """
+    Show git status.
+    """
+
+    result = run_git_command(["git", "status"], repo_path)
+
+    return result.stdout
+
+
+def add_files(repo_path, files):
+    """
+    Stage files for commit.
+    """
+
+    result = run_git_command(["git", "add", files], repo_path)
+
+    if result.returncode != 0:
+        raise RuntimeError("Failed to add files")
+
+
+def preview_staged_changes(repo_path):
+    """
+    Preview staged changes before committing.
+    """
+
+    result = run_git_command(["git", "diff", "--cached"], repo_path)
+
+    return result.stdout
+
+
+def has_changes_to_commit(repo_path):
+    """
+    Detect if there are staged changes.
+    """
+
+    result = run_git_command(
+        ["git", "diff", "--cached", "--quiet"],
+        repo_path
+    )
+
+    # returncode 0 means no changes
+    return result.returncode != 0
+
+
+def commit_changes(repo_path, message):
+    """
+    Commit staged changes.
+    """
+
+    result = run_git_command(
+        ["git", "commit", "-m", message],
+        repo_path
+    )
+
+    if result.returncode != 0:
+        raise RuntimeError("Commit failed")
+
+    return result.stdout
+
+
+def push_changes(repo_path):
+    """
+    Push commit to remote repository.
+    """
+
+    result = run_git_command(["git", "push"], repo_path)
+
+    if result.returncode != 0:
+        raise RuntimeError("Push failed")
+
+    return result.stdout
+
+
+def count_staged_files(repo_path):
+    """
+    Count number of staged files.
+    """
+
+    result = run_git_command(
+        ["git", "diff", "--name-only", "--cached"],
+        repo_path
+    )
+
+    if result.returncode != 0:
+        return 0
+
+    files = result.stdout.strip().splitlines()
+
+    return len(files)

daily_git_assistant/logger.py

@@ -0,0 +1,105 @@
+import os
+from pathlib import Path
+from datetime import datetime
+
+
+# Log file location
+LOG_PATH = os.path.join(Path.home(), ".commitflow.log")
+
+# Ensure log directory exists (future-proof safety)
+try:
+    log_dir = os.path.dirname(LOG_PATH)
+    if log_dir:
+        os.makedirs(log_dir, exist_ok=True)
+except Exception:
+    # Logging should never break the application
+    pass
+
+
+def _write_log(level, message):
+    """
+    Internal function to write log messages.
+    """
+
+    timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+
+    log_entry = f"[{timestamp}] [{level}] {message}\n"
+
+    try:
+        with open(LOG_PATH, "a", encoding="utf-8") as log_file:
+            log_file.write(log_entry)
+
+    except Exception:
+        # Logging should never crash the application
+        pass
+
+
+def log_info(message):
+    """
+    Log informational message.
+    """
+
+    _write_log("INFO", message)
+
+
+def log_warning(message):
+    """
+    Log warning message.
+    """
+
+    _write_log("WARNING", message)
+
+
+def log_error(message):
+    """
+    Log error message.
+    """
+
+    _write_log("ERROR", message)
+
+
+def log_commit(repo, branch, files, message, pushed):
+    """
+    Specialized log for commit operations.
+    """
+
+    commit_log = (
+        f"repo={repo} "
+        f"branch={branch} "
+        f"files={files} "
+        f"message='{message}' "
+        f"pushed={pushed}"
+    )
+
+    _write_log("COMMIT", commit_log)
+
+
+def read_logs(lines=20):
+    """
+    Read last N log entries.
+    """
+
+    if not os.path.exists(LOG_PATH):
+        return []
+
+    try:
+        with open(LOG_PATH, "r", encoding="utf-8") as f:
+            logs = f.readlines()
+
+        return logs[-lines:]
+
+    except Exception:
+        return []
+
+
+def clear_logs():
+    """
+    Clear log file.
+    """
+
+    try:
+        if os.path.exists(LOG_PATH):
+            open(LOG_PATH, "w").close()
+
+    except Exception:
+        pass