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

https://github.com/sh4shv4t/clotributor_scraper

Discover and analyze open-source contribution opportunities from clotributor.dev. Automatically scrape, filter, and summarize beginner-friendly GitHub issues to kickstart your open-source journey.
https://github.com/sh4shv4t/clotributor_scraper

automation contribution contributions-welcome gemini-api open-source python selenium

Last synced: 2 months ago
JSON representation

Discover and analyze open-source contribution opportunities from clotributor.dev. Automatically scrape, filter, and summarize beginner-friendly GitHub issues to kickstart your open-source journey.

Awesome Lists containing this project

README

          

# Clotributor Scraper

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/)

Clotributor Scraper is a tool designed to help developers discover and analyze open-source contribution opportunities from the site clotributor.dev. It automates the process of collecting, filtering, and presenting issues suitable for new and experienced contributors.

---

## Features

- 🔍 **Automated Scraping:** Collects issues from multiple open-source repositories.
- 🏷️ **Tag Filtering:** Filters issues by tags such as `good first issue`, `beginner`, `enhancement`, etc.
- 📄 **Structured Output:** Generates a human-readable summary of issues and their details.
- ⚡ **Easy to Use:** Simple command-line interface for quick setup and execution.

---

## Getting Started

### Prerequisites

- Python 3.8 or higher
- [pip](https://pip.pypa.io/en/stable/installation/)

### Installation

1. **Clone the repository:**
```bash
git clone https://github.com/your-username/clotributor_scraper.git
cd clotributor_scraper
```

2. **Install dependencies:**
```bash
pip install -r requirements.txt
```

---

## Usage

1. **Configure your environment:**
- Add your GitHub API token and other settings to a `.env` file (see `.env.example` if available).

2. **Run the scraper:**
```bash
python main.py
```

3. **View results:**
- Output will be saved to `output.txt` in the project directory.

---

## Project Structure

```
clotributor_scraper/

├── src/ # Source code
├── output.txt # Scraped issues summary
├── requirements.txt # Python dependencies
├── .gitignore
└── README.md
```

---

## Contributing

Contributions are welcome!