Skip to content

refactor: split CLI into modular package #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ElRobaMichis wants to merge 2 commits into
base: master
Choose a base branch
from
Open

refactor: split CLI into modular package #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4e6d6c
refactor CLI into modular package
ElRobaMichis May 12, 2026
834a38a
align module names with requested structure
ElRobaMichis May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,32 @@ Run `source ~/.zshrc` or restart terminal.

## Usage ⚡

## Project structure

The CLI entry point remains `gitHappens.py` so existing aliases keep working, but
the implementation is split into focused modules:

```
gitHappens.py # Compatibility wrapper
githappens/
main.py # Argument parsing and command routing
config.py # config.ini/templates.json loading
gitlab_api.py # GitLab and glab API interactions
git_utils.py # Local git helpers
interactive.py # Inquirer prompts and selections
templates.py # Template lookup rules
commands/
create_issue.py # Issue, branch, and MR creation workflow
open_mr.py # Open active MR in the browser
review.py # Reviewers, time tracking, and AI review
summary.py # Git summary and AI summary commands
report.py # Incident report workflow
deploy.py # Last production deployment lookup
```

This split keeps configuration, API calls, git shelling, prompts, and command
logic separate so each part can be tested and extended independently.

### Project selection

- Project selection is made automatically if you run script in same path as your project is located.
Expand Down Expand Up @@ -226,3 +252,11 @@ I suggest checking Gitlab's official API documentation: https://docs.gitlab.com/

Make sure to check this project on [OpenPledge](https://app.openpledge.io/repositories/zigcBenx/gitHappens).

## Development

Run the unit tests with:

```bash
python -m unittest discover
```

Loading