CLI tool to scrape GitHub repositories and combine Markdown files
Project description
github-docs-scraper
Simple CLI tool to scrape a GitHub repository (optionally a private one) and combine all the Markdown files it finds into a single file. This file can then be easily uploaded to ChatGPT, Deepseek, Qwen, etc.
Usage
Create a .env.local file with the following variables:
REPO_OWNER: The owner of the GitHub repository.REPO_NAME: The name of the GitHub repository.GITHUB_TOKEN: The GitHub personal access token.
For instance:
REPO_OWNER=your_org_name
REPO_NAME=your_repo_name
GITHUB_TOKEN=your_github_token
Installation
uv sync
uv run github-docs-scraper
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_docs_scraper-0.1.0.tar.gz.
File metadata
- Download URL: github_docs_scraper-0.1.0.tar.gz
- Upload date:
- Size: 4.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.4.27
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aca05762c998f689e183e069c00c1096384f2f2e51e4c3d0f14e17d331a8a1c1
|
|
| MD5 |
d16e40721d05ffa492e643dc1ebb9e06
|
|
| BLAKE2b-256 |
ce52d72fd549d7af0c66e4f715be279a07616536d04a0a49ee4c0ce4e6f20acb
|
File details
Details for the file github_docs_scraper-0.1.0-py3-none-any.whl.
File metadata
- Download URL: github_docs_scraper-0.1.0-py3-none-any.whl
- Upload date:
- Size: 2.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.4.27
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22471fa0cac829aed738e458f9b5084d207bd1000c298c638aefc4310cb5d4bf
|
|
| MD5 |
4f0a2d67249aa83b528cd8c6d52616b0
|
|
| BLAKE2b-256 |
6b677c9cfdd6aa640b826608c07686a1825247e0e4efb2e6b3f08e33ea66fd8e
|
