Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hirotoshioi/repo-digest-tool
Extract and summarize contents from GitHub repositories with advanced filtering options, tailored for LLM data preparation.
https://github.com/hirotoshioi/repo-digest-tool
Last synced: 24 days ago
JSON representation
Extract and summarize contents from GitHub repositories with advanced filtering options, tailored for LLM data preparation.
- Host: GitHub
- URL: https://github.com/hirotoshioi/repo-digest-tool
- Owner: HirotoShioi
- License: mit
- Created: 2024-12-02T18:59:11.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-10T00:26:18.000Z (25 days ago)
- Last Synced: 2024-12-10T00:27:46.849Z (25 days ago)
- Language: Python
- Size: 145 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Repo Digest Tool
A CLI tool for managing GitHub repositories and generating digest summaries, implemented with Typer.
---
## Features
- **Repository Digest Generation**: Creates digests of repositories and stores them in the `digests/` directory.
- **Repository Management**: Add, remove, update, or list repositories stored locally in the `repositories/` directory.
- **Custom Filtering**: Uses an LLM (Language Learning Model) for advanced filtering of repository contents based on user prompts.
- **HTML Reports**: Generates user-friendly HTML reports summarizing repository statistics and digest contents.
---
## Installation
### Requirements
- Python 3.12 or above
- `git` installed and accessible in your system path
### Setup
1. Clone the repository:
```bash
git clone https://github.com//repo-digest-tool.git
cd repo-digest-tool
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Optional: Install as a package for easier access:
```bash
pip install -e .
```
---
## Usage
### CLI Commands
Here’s a quick overview of the commands:
#### Add a Repository
```bash
repo add [--branch ] [--force]
```
- Adds a repository to local storage.
- Example:
```bash
repo add https://github.com/honojs/hono
repo add https://github.com/honojs/hono --branch develop --force
```
#### Remove a Repository
```bash
repo remove
```
- Removes a repository from local storage.
- Example:
```bash
repo remove https://github.com/honojs/hono
```
#### List Repositories
```bash
repo list
```
- Lists all repositories stored locally.
- Example:
```bash
repo list
```
#### Generate a Digest
```bash
repo digest [--branch ] [--prompt ] [--force]
```
- Generates a digest for a repository. Optional: specify a branch or a custom LLM filtering prompt.
- Example:
```bash
repo digest https://github.com/honojs/hono
repo digest https://github.com/honojs/hono --prompt "Focus on APIs"
```
#### Clear Repositories
```bash
repo clear [--all | --author ]
```
- Clears repositories from local storage. Either all or selectively by author.
- Example:
```bash
repo clear --all
repo clear --author honojs
```
#### Update a Repository
```bash
repo update
```
- Updates a repository by pulling the latest changes.
- Example:
```bash
repo update https://github.com/honojs/hono
```
---
## Development Roadmap
1. **Basic Functionality**:
- Repository management (`add`, `remove`, `list`).
- Digest generation.
2. **Digest Extensions**:
- LLM filtering with custom prompts.
- HTML report generation.
3. **Testing and Documentation**:
- Unit tests for all commands.
- Comprehensive documentation.
4. **Future Enhancements**:
- Multi-language report support.
- Integration with other platforms (e.g., GitLab).
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Contribution
Contributions are welcome! Please fork the repository and submit a pull request.