# MergeMate: Automated PR Review and Command Handling
[](https://github.com/Hardeepsingh980/mergemate/blob/master/LICENSE)
[](https://awesome.re)
MergeMate is a sophisticated tool crafted to automate pull request reviews and manage command-based interactions within GitHub issues. It harnesses LLMWare, a comprehensive development framework featuring tools and finely-tuned, to deliver insightful, context-aware responses directly within your git workflow.
## Features
- **Advanced Integration with LLMWare**: Leverages LLMWare to analyze code and manage interactions, utilizing the latest AI technologies for natural language understanding and decision-making.
- **Automated PR Reviews**: Generates thorough reviews for pull requests automatically, including specific code suggestions and adherence to best practices.
- **Command Handling**: Interprets and responds to commands in PR comments such as `/help`, `/explain`, `/status`, and `/ask`, enriching the interaction within PR discussions.
- **Markdown Support**: Improves readability and interaction by utilizing Markdown for formatting responses, complete with custom headers and footers.
- **Easy Integration**: Seamlessly integrates as a GitHub action, facilitating straightforward incorporation into any project's CI/CD pipeline.
- **Future Expansion Plans**: Aimed at extending support to other repository management platforms like GitLab and Bitbucket, broadening the accessibility and utility of MergeMate across different development environments.
## Installation
Install MergeMate quickly and easily via pip at [mergemate](https://pypi.org/project/mergemate/):
```bash
pip install mergemate
```
Deploying MergeMate prepares your environment to leverage advanced AI capabilities, streamlining project interactions and reviews.
## GitHub Action Setup
Incorporate MergeMate into your GitHub workflows using this configuration:
### Workflow Definition
Create the workflow file at `.github/workflows/mergemate.yml`.
```yaml
name: Automated PR Review and Command Handling
on:
pull_request:
types: [opened, synchronize]
issue_comment:
types: [created]
permissions:
issues: write
pull-requests: write
jobs:
review_pull_request:
if: ${{ github.event_name == 'pull_request' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9'
- name: Install dependencies
run: pip install mergemate
- name: Review PR
run: python -m mergemate.scripts.github.pr_review
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
handle_comment:
if: ${{ github.event_name == 'issue_comment' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/') }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9'
- name: Install dependencies
run: pip install mergemate
- name: Handle Comment
run: python -m mergemate.scripts.github.comment_handler
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
```
`NOTE`: Do not forget to add `OPENAI_API_KEY` in Github Secrets.
## Documentation
Extensive documentation is included within the package, providing detailed setup instructions, configuration options, and command usage. This ensures that users ranging from beginners to experienced developers can effectively utilize and customize MergeMate.
## Contributing
We warmly welcome contributions to MergeMate. If you are interested in enhancing its functionality or adapting it for additional use cases, please fork the repository and submit your pull requests. As an open-source project, MergeMate thrives on community involvement and contributions, which are crucial for its continuous evolution and enhancement.
## Licensing
MergeMate is proudly released under the MIT license. This permissive licensing fosters widespread adoption and significant contributions from the community, supporting both personal and commercial use.
---
MergeMate epitomizes the next step in automating interactions within GitHub's ecosystem, propelled by the ongoing advancement of AI-driven development tools. Your feedback and contributions are invaluable to us as we aim to continually expand and enhance MergeMate's capabilities, catering to a growing range of development environments and communities.
Raw data
{
"_id": null,
"home_page": "http://pypi.python.org/pypi/MergeMate/",
"name": "mergemate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Hardeep Singh",
"author_email": "hardeep0khalsa122@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/5f/607ac25bd1c4b3a9a54d84e8ed859d0f418d8011fb862285d99f7dc6aebb/mergemate-0.1.5.tar.gz",
"platform": null,
"description": "\n# MergeMate: Automated PR Review and Command Handling\n[](https://github.com/Hardeepsingh980/mergemate/blob/master/LICENSE)\n\n\n[](https://awesome.re)\n\n\nMergeMate is a sophisticated tool crafted to automate pull request reviews and manage command-based interactions within GitHub issues. It harnesses LLMWare, a comprehensive development framework featuring tools and finely-tuned, to deliver insightful, context-aware responses directly within your git workflow.\n\n## Features\n\n- **Advanced Integration with LLMWare**: Leverages LLMWare to analyze code and manage interactions, utilizing the latest AI technologies for natural language understanding and decision-making.\n- **Automated PR Reviews**: Generates thorough reviews for pull requests automatically, including specific code suggestions and adherence to best practices.\n- **Command Handling**: Interprets and responds to commands in PR comments such as `/help`, `/explain`, `/status`, and `/ask`, enriching the interaction within PR discussions.\n- **Markdown Support**: Improves readability and interaction by utilizing Markdown for formatting responses, complete with custom headers and footers.\n- **Easy Integration**: Seamlessly integrates as a GitHub action, facilitating straightforward incorporation into any project's CI/CD pipeline.\n- **Future Expansion Plans**: Aimed at extending support to other repository management platforms like GitLab and Bitbucket, broadening the accessibility and utility of MergeMate across different development environments.\n\n## Installation\n\nInstall MergeMate quickly and easily via pip at [mergemate](https://pypi.org/project/mergemate/):\n\n```bash\npip install mergemate\n```\n\nDeploying MergeMate prepares your environment to leverage advanced AI capabilities, streamlining project interactions and reviews.\n\n## GitHub Action Setup\n\nIncorporate MergeMate into your GitHub workflows using this configuration:\n\n### Workflow Definition\n\nCreate the workflow file at `.github/workflows/mergemate.yml`.\n```yaml\nname: Automated PR Review and Command Handling\n\non:\n pull_request:\n types: [opened, synchronize]\n issue_comment:\n types: [created]\n\npermissions:\n issues: write\n pull-requests: write\n\njobs:\n review_pull_request:\n if: ${{ github.event_name == 'pull_request' }}\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - name: Set up Python\n uses: actions/setup-python@v2\n with:\n python-version: '3.9'\n - name: Install dependencies\n run: pip install mergemate\n - name: Review PR\n run: python -m mergemate.scripts.github.pr_review\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}\n\n handle_comment:\n if: ${{ github.event_name == 'issue_comment' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/') }}\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - name: Set up Python\n uses: actions/setup-python@v2\n with:\n python-version: '3.9'\n - name: Install dependencies\n run: pip install mergemate\n - name: Handle Comment\n run: python -m mergemate.scripts.github.comment_handler\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}\n```\n`NOTE`: Do not forget to add `OPENAI_API_KEY` in Github Secrets.\n\n## Documentation\n\nExtensive documentation is included within the package, providing detailed setup instructions, configuration options, and command usage. This ensures that users ranging from beginners to experienced developers can effectively utilize and customize MergeMate.\n\n## Contributing\n\nWe warmly welcome contributions to MergeMate. If you are interested in enhancing its functionality or adapting it for additional use cases, please fork the repository and submit your pull requests. As an open-source project, MergeMate thrives on community involvement and contributions, which are crucial for its continuous evolution and enhancement.\n\n## Licensing\n\nMergeMate is proudly released under the MIT license. This permissive licensing fosters widespread adoption and significant contributions from the community, supporting both personal and commercial use.\n\n---\n\nMergeMate epitomizes the next step in automating interactions within GitHub's ecosystem, propelled by the ongoing advancement of AI-driven development tools. Your feedback and contributions are invaluable to us as we aim to continually expand and enhance MergeMate's capabilities, catering to a growing range of development environments and communities.\n",
"bugtrack_url": null,
"license": "LICENSE.txt",
"summary": "An automated tool to handle GitHub pull requests and comments.",
"version": "0.1.5",
"project_urls": {
"Homepage": "http://pypi.python.org/pypi/MergeMate/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13c1178c9ae81cd350984bf8eb30f9d4c8e5fe4f1bf000998c9243e93677b9e8",
"md5": "00e40eed02df59ee466df69e0106cac5",
"sha256": "c898bfdb7714f9315487eabcaeb9a08fe61480c69cae3595078d3c202c689404"
},
"downloads": -1,
"filename": "mergemate-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00e40eed02df59ee466df69e0106cac5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9999,
"upload_time": "2024-05-19T12:26:28",
"upload_time_iso_8601": "2024-05-19T12:26:28.050271Z",
"url": "https://files.pythonhosted.org/packages/13/c1/178c9ae81cd350984bf8eb30f9d4c8e5fe4f1bf000998c9243e93677b9e8/mergemate-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "445f607ac25bd1c4b3a9a54d84e8ed859d0f418d8011fb862285d99f7dc6aebb",
"md5": "4c5a7421e7dcf5ee19c1a4685651a474",
"sha256": "cdc95c5d815c63deae86d9e8384a5dfeef5b9bb9fb6bf9695b4d699a8ac52679"
},
"downloads": -1,
"filename": "mergemate-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "4c5a7421e7dcf5ee19c1a4685651a474",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9117,
"upload_time": "2024-05-19T12:26:30",
"upload_time_iso_8601": "2024-05-19T12:26:30.217957Z",
"url": "https://files.pythonhosted.org/packages/44/5f/607ac25bd1c4b3a9a54d84e8ed859d0f418d8011fb862285d99f7dc6aebb/mergemate-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 12:26:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mergemate"
}
JSON