This project generates newsletters based on GitHub repository activity using LLM-powered summaries and insights.
-
Create a conda environment:
conda create -n newsletter_generator python=3.8 conda activate newsletter_generator
-
Install the required packages:
pip install -r requirements.txt
-
Set up your GitHub API and OpenAI API credentials in a
.env
file:GITHUB_TOKEN=your_github_token OPENAI_API_KEY=your_openai_api_key
-
Run the application:
cd src python app.py
- Navigate to the application in your web browser.
- Enter the repository URL, start date, and end date.
- Click on "Generate Newsletter" to create your newsletter based on the specified repository activity.
- Generates newsletters summarizing recent commits, issues, and pull requests.
- Provides insights into repository activity, including top contributors and commit patterns.
- AI-generated summaries for better readability and engagement.