GitHub Agent is an open-source AI-based tool designed for developers and project managers to efficiently track and manage updates in subscribed GitHub repositories. By providing regular (daily/weekly) summaries, GitHub Agent helps teams stay informed on project progress, enabling faster responses and more effective collaboration.
- Subscription Management: Easily manage GitHub repository subscriptions.
- Update Fetching: Automatically fetch the latest updates from subscribed repositories.
- Notification System: Notify users of new updates via email, Slack, etc.
- Report Generation: Generate regular update reports (daily/weekly) to keep track of project changes.
-
Clone the repository:
git clone https://github.com/axpz/githubAgent.git cd githubAgent -
Activate your Python environment:
source ~/python/env/jupyter/bin/activate
-
Install dependencies:
pip install -r requirements.txt
-
Set up your repository subscriptions: Use the subscription management module (subscription.py) to add or remove repositories you want to track.
-
Run GitHub Agent: To start fetching updates and generating reports, run:
python main.py
-
Configure Notifications: Adjust the notifier.py module to set up your preferred notification channels (e.g., email, Slack).
-
Generate Reports: The agent will automatically generate reports at the specified intervals. You can find the generated report in
update_report.json.
Contributions are welcome! If you would like to improve GitHub Agent, please feel free to fork the repository and submit a pull request.
To run tests, use:
pytestThis project is licensed under the MIT License. See the LICENSE file for details.
For any questions or suggestions, please open an issue or contact the repository owner.