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.
- 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.
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
.
-
Clone the repository to your local machine:
git clone https://github.com/gmpsankalpa/github-repo-search-tool.git
-
Navigate to the project directory:
cd github-repo-search-tool
-
Create a virtual environment (optional but recommended):
python -m venv venv
-
Activate the virtual environment:
-
On Windows:
.\venv\Scripts\activate
-
On macOS and Linux:
source venv/bin/activate
-
-
Install required Python packages:
pip install -r requirements.txt
-
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:GITHUB_TOKEN=your-github-token
-
-
Run the application:
python github_search_tool.py
-
In the GUI, enter a search query and click the "Search" button.
-
View the search results in the interface.
-
Optionally, click the "Export to PDF" button to save the results to a PDF file.
Contributions are welcome! Please follow these guidelines:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
. - Make your changes and commit them:
git commit -m 'Add new feature'
. - Push to the branch:
git push origin feature/your-feature-name
. - Create a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
- Thanks to the GitHub API for providing the data used in this application.
Happy coding!