Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/llmkira/contributor

✨ Custom AI Assistant: Leverage OpenAI for auto Issue review and Pull Request review. | 自用定制AI助理开源维护工具省心放心
https://github.com/llmkira/contributor

assistant collaboration github-app gpt-4 gpt-4o productivity

Last synced: 6 days ago
JSON representation

✨ Custom AI Assistant: Leverage OpenAI for auto Issue review and Pull Request review. | 自用定制AI助理开源维护工具省心放心

Host: GitHub
URL: https://github.com/llmkira/contributor
Owner: LlmKira
License: other
Created: 2024-05-27T03:59:29.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-07-31T05:58:42.000Z (4 months ago)
Last Synced: 2024-08-01T06:30:13.101Z (3 months ago)
Topics: assistant, collaboration, github-app, gpt-4, gpt-4o, productivity
Language: Python
Homepage: https://github.com/apps/neutron-nerve
Size: 779 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![Contributor](.github/contributor_banner.png)

-----------------

# Custom AI Assistant

[中文README](README_CN.md)

> [!WARNING]

> Our App is still in the testing phase, so we maybe clear user data. Please be careful when using it.

In a nutshell, to better manage projects, we need an enhanced Issue management tool. This is why I created this project.

By configuring bots with repository files, everyone can freely customize the bot. The bot will automatically handle

repository events based on the configuration file.

This project was inspired by

the [ai-pr-reviewer](https://github.com/coderabbitai/ai-pr-reviewer/) project

However, it's unfortunate that they have decided to close their repository and code. Using it requires additional

payment, and

although payment is necessary, I don't like closed systems and monthly billing. I prefer open, pay-as-you-go (or

self-hosted) services.

This repository includes a configuration file template, which you can use to set up your bot. Sensitive information

such as keys can be configured through my panel.

[**Dashboard**](https://contributor.dianas.cyou)

[**Get AI Service all-in-one**](https://www.ohmygpt.com/)

## Quick Start

1. **Install the App**: Click [**Install to your Repo**](https://github.com/apps/neutron-nerve).

2. **Get Repo Token**: Add apikeys and other sensitive information to

   the [App Dashboard](https://contributor.dianas.cyou).

3. **Build the `.nerve.toml` File**: Create a configuration file based on the template. [Example](.nerve.toml)

> [!INFO]

> The panel is only used to store API-related keys. You fill in the UUID to your repository, and GithubApp

> collaborates with the repository to finally obtain the customized configuration.

## Features

| Feature                     | Description                                                             |

|-----------------------------|-------------------------------------------------------------------------|

| 🌐 **Dashboard**            | Intuitive web panel for managing sensitive data and key configurations. |

| 📂 **Auto Labeling**        | Automatically label issues based on the configuration file.             |

| 📝 **Issue Closed Report**  | Generate a report when an issue is closed.                              |

| 📌 **Issue Title Standard** | Standardize issue titles.                                               |

| 🗂 ~~**Issue Summary**~~    | Generate a summary of issues based on the configuration file.           |

| 📦 ~~**Release Note**~~     | Generate release notes based on the configuration file.                 |

| 📚 ~~**Documentation**~~    | Automatically translate documentation.                                  |

```mermaid

sequenceDiagram

    participant User

    participant Dashboard

    participant Repository

    participant GithubApp

    participant Robot

    User ->> Dashboard: Provides sensitive information

    Dashboard ->> User: Returns UUID

    User ->> Repository: Provides UUID

    Repository ->> GithubApp: Provides UUID and requests operation

    GithubApp ->> Robot: Verifies repository with UUID

    Robot ->> GithubApp: Confirms repository validity

    GithubApp -->> Repository: Executes operation

```

## Custom Operations

Although the project may seem complex, adding new operations is actually quite simple. GitHub passes events through

webhooks, and we only need to handle these events and then execute our operations.

Please open the [main.py](main.py) file and add your custom operations.

Here is an example of a new listener:

```python

webhook_handler = ...

git_integration = ...

get_repo_setting = ...

logger = ...

from core.webhook.event_type import IssueComment

@webhook_handler.listen(IssueComment, action=IssueComment.CREATED, unique_id="uuid")

async def handle_issue_comment(event: IssueComment.CREATED_EVENT):

    logger.info("Received IssueComment.CREATED event")

    repo_setting = get_repo_setting(

        repo_name=event.repository.full_name,

        repo=event.repository.get_repo(git_integration)

    )

    # repo_setting is the content of the .nerve.toml file

    issue = event.repository.get_issue(integration=git_integration, issue_number=event.issue.number)

    comment = issue.create_comment(f"Hello World!")

    issue.get_comment(comment.id).edit("Hello World! Edited")

    print(f"Issue: {event.issue.title}")

    print(f"Comment: {event.comment.body}")

    print(f"Repo: {event.repository.full_name}")

```

The same event can have multiple listeners, as long as each listener has a different `unique_id`.

## Deploy App

To deploy the app locally, follow these easy steps:

````shell

pdm install

npm install

cp .env.example .env

nano .env

pm2 start pm2.json

````

## Acknowledgements

Special thanks to these resources that made this project possible:

- [chmouel/gosmee](https://github.com/chmouel/gosmee)

- [octokit/webhooks](https://github.com/octokit/webhooks/blob/main/payload-examples/api.github.com/issues/assigned.payload.json)

- [GitHub Webhooks Documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issues)

- [GitHub Webhooks Validation](https://docs.github.com/zh/webhooks/using-webhooks/validating-webhook-deliveries)

- [PyGithub Examples](https://github.com/PyGithub/PyGithub/blob/main/doc/examples/Issue.rst)

## License

This project is licensed under the MIT License with Non-Commercial Clause - see the [LICENSE](./LICENSE) file for

details.

### Non-Commercial Use

You are free to use this software for any non-commercial purposes.

### Commercial Use

For commercial use, please contact us to obtain a commercial license.

## Contributing

We welcome contributions! Please check out our [contributing guidelines](CONTRIBUTOR_LICENSE_AGREEMENT) for more

information.

## ⭐️ Star us

If you find this project helpful, don't forget to give us a star! ⭐️

Happy Coding! 💻