{"id":17678524,"url":"https://github.com/antoinegagne/treewalker","last_synced_at":"2026-02-11T00:35:46.246Z","repository":{"id":98373328,"uuid":"230819938","full_name":"AntoineGagne/treewalker","owner":"AntoineGagne","description":"A web crawler in Erlang that respects `robots.txt`.","archived":false,"fork":false,"pushed_at":"2023-02-27T18:39:55.000Z","size":48,"stargazers_count":2,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T07:23:07.195Z","etag":null,"topics":["crawler","erlang","webcrawler"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AntoineGagne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2019-12-30T00:25:40.000Z","updated_at":"2023-04-12T03:11:06.000Z","dependencies_parsed_at":"2023-07-08T22:15:38.994Z","dependency_job_id":null,"html_url":"https://github.com/AntoineGagne/treewalker","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/AntoineGagne/treewalker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoineGagne%2Ftreewalker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoineGagne%2Ftreewalker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoineGagne%2Ftreewalker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoineGagne%2Ftreewalker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AntoineGagne","download_url":"https://codeload.github.com/AntoineGagne/treewalker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoineGagne%2Ftreewalker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272072243,"owners_count":24868397,"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-08-25T02:00:12.092Z","response_time":1107,"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":["crawler","erlang","webcrawler"],"created_at":"2024-10-24T08:05:08.399Z","updated_at":"2026-02-11T00:35:41.202Z","avatar_url":"https://github.com/AntoineGagne.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# treewalker\n\n[![Build Status](https://github.com/AntoineGagne/treewalker/actions/workflows/erlang.yml/badge.svg)](https://github.com/AntoineGagne/treewalker/actions)\n[![Hex Pm](http://img.shields.io/hexpm/v/treewalker.svg?style=flat)](https://hex.pm/packages/treewalker)\n[![Coverage](https://coveralls.io/repos/github/AntoineGagne/treewalker/badge.svg?branch=master)](https://coveralls.io/github/AntoineGagne/treewalker?branch=master)\n\nA web crawler in Erlang that respects `robots.txt`.\n\n## Installation\n\nThis library is available on [hex.pm](https://hex.pm/packages/treewalker).\n\nKeep in mind that the library is not yet stable and its API may be\nsubject to changes.\n\n## Usage\n\n```erlang\n%% This will add the specified crawler to the supervision tree\n{ok, _} = treewalker:add_crawler(example, #{scraper =\u003e example_scraper,\n                                            fetcher =\u003e example_fetcher,\n                                            max_depth =\u003e 3,\n                                            link_filter =\u003e example_link_filter,\n                                            store =\u003e example_store}),\n%% Starts crawling\nok = treewalker:start_crawler(example),\n%% ...\n%% Stops the crawler\n%% The pending requests will be completed and dropped\nok = treewalker:stop_crawler(example),\n```\n\n## Options\n\nThe following settings are available via the `sys.config` configuration:\n\n```erlang\n{treewalker, [\n              %% The minimum delay to wait before retrying a failed request\n              {min_retry_delay, pos_integer()},\n              %% The maximum delay to wait before retrying a failed request\n              {max_retry_delay, pos_integer()},\n              %% The maximum amount of retries of a failed request\n              {max_retries, pos_integer()},\n              %% The maximum amount of delay before starting a request (in seconds)\n              {max_worker_delay, pos_integer()},\n              %% The maximum amount of concurrent workers making HTTP requests\n              {max_concurrent_worker, pos_integer()},\n              %% The user agent making the HTTP requests\n              {user_agent, binary()}]},\n```\n\n## Development\n\n### Running all the tests and linters\n\nYou can run all the tests and linters with the `rebar3` alias:\n\n```sh\nrebar3 check\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoinegagne%2Ftreewalker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoinegagne%2Ftreewalker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoinegagne%2Ftreewalker/lists"}