{"id":26145859,"url":"https://github.com/compiler-inc/doc-scraper","last_synced_at":"2025-10-20T12:00:11.735Z","repository":{"id":280924651,"uuid":"942965542","full_name":"Compiler-Inc/doc-scraper","owner":"Compiler-Inc","description":"Scrape API docs into beautiful markdown","archived":false,"fork":false,"pushed_at":"2025-03-06T03:16:55.000Z","size":17,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T03:09:41.313Z","etag":null,"topics":["api","docs","python","scraper"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Compiler-Inc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-05T00:54:59.000Z","updated_at":"2025-03-18T00:00:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"1f5e46a9-3806-4cdc-8683-735f8735fed7","html_url":"https://github.com/Compiler-Inc/doc-scraper","commit_stats":null,"previous_names":["compiler-inc/doc-scraper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Compiler-Inc/doc-scraper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Compiler-Inc%2Fdoc-scraper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Compiler-Inc%2Fdoc-scraper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Compiler-Inc%2Fdoc-scraper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Compiler-Inc%2Fdoc-scraper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Compiler-Inc","download_url":"https://codeload.github.com/Compiler-Inc/doc-scraper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Compiler-Inc%2Fdoc-scraper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280087873,"owners_count":26269718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-20T02:00:06.978Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docs","python","scraper"],"created_at":"2025-03-11T04:56:20.325Z","updated_at":"2025-10-20T12:00:11.730Z","avatar_url":"https://github.com/Compiler-Inc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doc Scraper\n\nA flexible documentation crawler that can scrape and process documentation from any website.\n\n## Installation\n\nFirst install dependencies:\n```bash\npip install -r requirements.txt\n```\n\nThen install the package in editable mode:\n```bash\npip install -e .\n```\n\nThe `-e` flag installs the package in \"editable\" mode, which means:\n- The package is installed in your Python environment\n- Python looks for the package in your current directory instead of copying files\n- Changes to the source code take effect immediately without reinstalling\n- Required for running the package as a module with `python -m`\n\n### Environment Setup\n\nCreate a `.env` file in the project root:\n```bash\nOPENAI_API_KEY=your_api_key_here\n```\n\n⚠️ The OpenAI API key is required for the crawler to process documentation.\n\n## Usage\n\nRun the scraper with a URL from the `src` directory:\n\n```bash\ncd src\npython main.py https://docs.example.com\n```\n\n### Optional Arguments\n\n- `-o, --output`: Output directory (default: output_docs)\n- `-m, --max-pages`: Maximum pages to scrape (default: 1000)\n- `-c, --concurrent`: Number of concurrent pages to scrape (default: 1)\n\nExample with all options:\n```bash\npython main.py https://docs.example.com -o my_docs -m 500 -c 2\n```\n\n### Troubleshooting\n\nIf you get a \"ModuleNotFoundError\", make sure you:\n1. Have run `pip install -e .` from the project root\n2. Are running the command from the `src` directory\n\n## Configuration\n\nThe crawler accepts the following parameters:\n\n- `base_url`: The starting URL to crawl\n- `output_dir`: Directory where scraped docs will be saved\n- `max_pages`: Maximum number of pages to crawl\n- `max_concurrent_pages`: Number of concurrent pages to process\n\n## Requirements\n\n- Python 3.8+\n- Chrome/Chromium browser (for Selenium)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompiler-inc%2Fdoc-scraper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompiler-inc%2Fdoc-scraper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompiler-inc%2Fdoc-scraper/lists"}