Skip to content

refactor: split CLI into modular package #161

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
rtmalikian wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor: split CLI into modular package #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,27 @@ Add following line to your `.bashrc` or `.zshrc` file

Run `source ~/.zshrc` or restart terminal.

## Project structure

GitHappens keeps `gitHappens.py` as the executable compatibility entrypoint, while the implementation lives in focused modules:

```text
githappens/
├── main.py # Argument parsing and command dispatch
├── config.py # config.ini and templates.json loading
├── gitlab_api.py # GitLab API and glab helpers
├── git_utils.py # Local git helpers
├── templates.py # Issue template selection
├── interactive.py # inquirer prompt wrappers
└── commands/
├── create_issue.py # Issue, branch, and merge request creation flow
├── deploy.py # Last production deploy lookup
├── open_mr.py # Current branch merge request browser opener
├── report.py # Incident report command
├── review.py # Review, reviewer, time tracking, and auto-merge flow
└── summary.py # Commit summaries and AI summaries
```

## Usage ⚡

### Project selection
Expand Down Expand Up @@ -225,4 +246,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