Skip to content

Refactor monolithic CLI into modular architecture #138

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
subhajitlucky wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Refactor monolithic CLI into modular architecture #138

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
a02f2f1
refactor: split CLI into modular package
subhajitlucky May 12, 2026
e17889d
test: cover extracted command modules
subhajitlucky May 13, 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
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ Run `source ~/.zshrc` or restart terminal.

## Usage ⚡

### Project structure

The executable `gitHappens.py` is a small compatibility wrapper around the
`githappens` package:

- `githappens/main.py` handles CLI argument parsing and command routing.
- `githappens/config.py` loads `configs/config.ini`.
- `githappens/templates.py` loads issue templates and reviewer settings.
- `githappens/gitlab_api.py` contains GitLab API and `glab` interactions.
- `githappens/git_utils.py` contains local Git helpers.
- `githappens/interactive.py` contains terminal prompts.
- `githappens/commands/` contains command-specific workflows.

### Project selection

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

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

Loading