Metadata-Version: 2.4
Name: github-readme-tool-fangxingzhu
Version: 0.1.0
Summary: A simple tool to fetch and clean GitHub repository README files
Author: fangxingzhu
Author-email: fangxingzhu123456@163.com
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: markdown>=3.5.0
Requires-Dist: tqdm>=4.65.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# github-readme-tool-fangxingzhu
A simple tool to fetch and clean GitHub repository README files.

## Installation
Install the package via pip:
```bash
pip install github-readme-tool-fangxingzhu
## Quick Start
After installation, you can fetch GitHub README with just 3 lines of code:

```python
# Import the tool
from github_readme_tool import github_proj_readme_crawler

# Fetch README of a GitHub repository (e.g., "octocat/hello-world" is a test repo)
saved_path = github_proj_readme_crawler.get_repo_readme("octocat/hello-world")

# Print the saved path (check the file on your computer)
print(f"✅ README saved successfully! Path: {saved_path}")
