A simple tool to fetch and clean GitHub repository README files
Project description
github-readme-tool-fangxingzhu
A simple tool to fetch and clean GitHub repository README files.
Installation
Install the package via pip:
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}")
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file github_readme_tool_fangxingzhu-0.1.0.tar.gz.
File metadata
- Download URL: github_readme_tool_fangxingzhu-0.1.0.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba61c75ed1ff60d1e4b8c9f849376c0c649cb8ea0e795218845b69f4afaa11ec
|
|
| MD5 |
a2962965877f9321df77ee927d0066ce
|
|
| BLAKE2b-256 |
b03792ca1692b694f03bac8e4b236bfcccabf9fdd4103aa5e3fa50eda7f4fbab
|
File details
Details for the file github_readme_tool_fangxingzhu-0.1.0-py3-none-any.whl.
File metadata
- Download URL: github_readme_tool_fangxingzhu-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73f3d5b5bd80f21bc9165f07306b0428338cd7fb566e3074513ffc0c31c2d325
|
|
| MD5 |
a8d73fdad6b200d6f0182d8782ec5634
|
|
| BLAKE2b-256 |
3d1b50f3ae1084780f9a91afd06979be67068192057b2a237124add293d9fba7
|
