{"id":28569902,"url":"https://github.com/bgunyel/summary-writer","last_synced_at":"2025-06-10T17:39:34.806Z","repository":{"id":295281956,"uuid":"989640356","full_name":"bgunyel/summary-writer","owner":"bgunyel","description":"AI module to research and write a short summary about a given topic","archived":false,"fork":false,"pushed_at":"2025-06-07T10:30:07.000Z","size":79,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-07T11:27:15.197Z","etag":null,"topics":["ai","ai-automation","ai-workflow"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bgunyel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-24T14:16:26.000Z","updated_at":"2025-06-07T10:30:12.000Z","dependencies_parsed_at":"2025-05-24T17:28:19.701Z","dependency_job_id":"52d2bb1f-98a0-4c58-9a13-5690eec1ff37","html_url":"https://github.com/bgunyel/summary-writer","commit_stats":null,"previous_names":["bgunyel/summary-writer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bgunyel%2Fsummary-writer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bgunyel%2Fsummary-writer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bgunyel%2Fsummary-writer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bgunyel%2Fsummary-writer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bgunyel","download_url":"https://codeload.github.com/bgunyel/summary-writer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bgunyel%2Fsummary-writer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259118827,"owners_count":22808063,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-automation","ai-workflow"],"created_at":"2025-06-10T17:39:33.891Z","updated_at":"2025-06-10T17:39:34.789Z","avatar_url":"https://github.com/bgunyel.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Summary Writer\n\nAn AI-powered research tool that automatically generates comprehensive summaries on any topic by intelligently searching the web and synthesizing information using large language models.\n\n## Overview\n\nSummary Writer uses a multi-step workflow to research topics and create high-quality summaries:\n\n1. **Query Generation** - Creates targeted web search queries for comprehensive coverage\n2. **Web Search** - Searches the internet using Tavily API for relevant, up-to-date information  \n3. **Summary Writing** - Synthesizes search results into coherent summaries using reasoning models\n\n## Features\n\n- **Multi-LLM Support**: Compatible with Groq, OpenAI, VLLM, and Ollama\n- **Intelligent Query Generation**: Automatically creates diverse search queries to cover all aspects of a topic\n- **Web Search Integration**: Uses Tavily API for comprehensive web search capabilities\n- **Advanced Reasoning**: Leverages reasoning models for high-quality summary generation\n- **Configurable Workflow**: Customizable research iterations and query parameters\n- **LangGraph Orchestration**: Uses LangGraph for robust workflow management\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone \u003crepository-url\u003e\ncd summary-writer\n\n# Install dependencies using uv\nuv sync\n```\n\n## Configuration\n\nSet up your API keys in environment variables:\n\n```bash\nexport GROQ_API_KEY=\"your-groq-api-key\"\nexport OPENAI_API_KEY=\"your-openai-api-key\" \nexport TAVILY_API_KEY=\"your-tavily-api-key\"\n```\n\n## Usage\n\n### Basic Usage\n\n```python\nfrom summary_writer import SummaryWriter\nfrom ai_common import LlmServers\n\n# Initialize the summary writer\nwriter = SummaryWriter(\n    llm_server=LlmServers.GROQ,\n    llm_config={\n        'language_model': 'llama-3.3-70b-versatile',\n        'reasoning_model': 'deepseek-r1-distill-llama-70b',\n        'groq_api_key': 'your-api-key'\n    },\n    web_search_api_key='your-tavily-api-key'\n)\n\n# Generate a summary\nresponse = writer.get_response({'topic': 'artificial intelligence trends 2024'})\nprint(response)\n```\n\n### Running the Development Script\n\n```bash\npython src/main_dev.py\n```\n\n## Project Structure\n\n```\nsrc/\n├── summary_writer/\n│   ├── summary_writer.py      # Main SummaryWriter class and workflow\n│   ├── state.py               # State management for the workflow\n│   ├── configuration.py       # Configuration settings\n│   ├── enums.py              # Enums and constants\n│   └── components/\n│       ├── query_writer.py    # Generates search queries\n│       └── writer.py          # Creates summaries from search results\n├── main_dev.py               # Development entry point\n└── config.py                 # Application configuration\n```\n\n## Dependencies\n\n- **LangChain**: For LLM integration and workflow orchestration\n- **LangGraph**: For building the research workflow graph\n- **Tavily**: For web search capabilities\n- **AI Common**: Shared utilities and base classes\n- **Rich**: For enhanced console output\n\n## License\n\nThis project is licensed under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbgunyel%2Fsummary-writer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbgunyel%2Fsummary-writer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbgunyel%2Fsummary-writer/lists"}