https://github.com/gmpsankalpa/github-repo-search-tool
This is a Python application with a Tkinter-based GUI that allows users to search GitHub repositories based on a query. The search results are displayed in the graphical interface, and users can export the results to a styled PDF with clickable links.
https://github.com/gmpsankalpa/github-repo-search-tool
python
Last synced: 3 months ago
JSON representation
This is a Python application with a Tkinter-based GUI that allows users to search GitHub repositories based on a query. The search results are displayed in the graphical interface, and users can export the results to a styled PDF with clickable links.
- Host: GitHub
- URL: https://github.com/gmpsankalpa/github-repo-search-tool
- Owner: gmpsankalpa
- License: mit
- Created: 2024-03-03T07:09:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-03T07:14:27.000Z (over 1 year ago)
- Last Synced: 2025-01-17T08:32:18.327Z (5 months ago)
- Topics: python
- Language: Python
- Homepage: https://gmpsankalpa.xyz
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Repository Search Tool
This is a Python application with a Tkinter-based GUI that allows users to search GitHub repositories based on a query. The search results are displayed in the graphical interface, and users can export the results to a styled PDF with clickable links.
## Features
- **GitHub Repository Search:** Input a query to search for repositories on GitHub.
- **Graphical User Interface (GUI):** A user-friendly interface for interacting with the application.
- **Export to PDF:** Save the search results to a PDF document with clickable repository links.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Python 3.x installed on your machine.
- Install required Python packages using `pip install -r requirements.txt`.
## Installation
1. Clone the repository to your local machine:
```bash
git clone https://github.com/gmpsankalpa/github-repo-search-tool.git
```
2. Navigate to the project directory:
```bash
cd github-repo-search-tool
```
3. Create a virtual environment (optional but recommended):
```bash
python -m venv venv
```
4. Activate the virtual environment:
- On Windows:
```bash
.\venv\Scripts\activate
```
- On macOS and Linux:
```bash
source venv/bin/activate
```
5. Install required Python packages:
```bash
pip install -r requirements.txt
```
## Usage
1. Set up your GitHub Personal Access Token:
- Create a file named `.env` in the project directory.
- Add your GitHub Personal Access Token to the `.env` file:
```env
GITHUB_TOKEN=your-github-token
```
2. Run the application:
```bash
python github_search_tool.py
```
3. In the GUI, enter a search query and click the "Search" button.
4. View the search results in the interface.
5. Optionally, click the "Export to PDF" button to save the results to a PDF file.
## Contributing
Contributions are welcome! Please follow these guidelines:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature-name`.
3. Make your changes and commit them: `git commit -m 'Add new feature'`.
4. Push to the branch: `git push origin feature/your-feature-name`.
5. Create a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to the GitHub API for providing the data used in this application.
---
Happy coding!