{"id":21569388,"url":"https://github.com/aweirddev/wikivoyage","last_synced_at":"2025-03-18T05:45:12.798Z","repository":{"id":239277760,"uuid":"799084709","full_name":"AWeirdDev/wikivoyage","owner":"AWeirdDev","description":"Consume Wikivoyage pages into pure (elegant) Markdown. Probably.","archived":false,"fork":false,"pushed_at":"2024-05-11T12:58:27.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T12:32:28.815Z","etag":null,"topics":["scraper","travel","wikipedia","wikipedia-api","wikivoyage"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AWeirdDev.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":"2024-05-11T06:22:31.000Z","updated_at":"2024-08-27T21:26:48.000Z","dependencies_parsed_at":"2024-05-11T07:29:36.614Z","dependency_job_id":"00c30df3-2353-43bf-9712-56ee4eb7496f","html_url":"https://github.com/AWeirdDev/wikivoyage","commit_stats":null,"previous_names":["aweirddev/wikivoyage"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AWeirdDev%2Fwikivoyage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AWeirdDev%2Fwikivoyage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AWeirdDev%2Fwikivoyage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AWeirdDev%2Fwikivoyage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AWeirdDev","download_url":"https://codeload.github.com/AWeirdDev/wikivoyage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166677,"owners_count":20409178,"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","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":["scraper","travel","wikipedia","wikipedia-api","wikivoyage"],"created_at":"2024-11-24T11:09:19.874Z","updated_at":"2025-03-18T05:45:12.764Z","avatar_url":"https://github.com/AWeirdDev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wikivoyage\n\nConsume [Wikivoyage](https://en.wikivoyage.org) into pure (elegant) Markdown. Probably.\n\n```\n$ pip install wikivoyage\n```\n\n## Usage\n\nJust do what you want.\n\n```python\nimport wikivoyage\n\n# Learn about the States\nres = wikivoyage.get(\"https://en.wikivoyage.org/wiki/United_States_of_America\")\nprint(res)\n```\n\n```python\nWikivoyageSections(\n    url='https://en.wikivoyag…',\n    sections=[\n        Section(\n            title='United States of America', \n            content='The **United States of America** spans a continent…'\n        ), \n        Section(\n            title='Regions', \n            content=\"Wikivoyage organizes the 50 states and the nation'…\"\n        ), \n        Section(\n            title='Cities', \n            content='The following is a list of nine of the most notabl…'\n        ),\n        ...\n    ]\n)\n```\n\nSuper simple.\n\n## Why?\n\nI'm initially an \"i-aint-reading-allat\" person, thus I made this project so I can better categorize all the sections from a Wikivoyage page, feed it to an LLM and summarize it for me.\n\nCheck out [where-next](https://github.com/AWeirdDev/where-next), a Next.JS project created by me to learn more.\n\n## API Reference\n\nThe juicy API reference. Press \u003ckbd\u003eCTRL + F\u003c/kbd\u003e to search for what you need or type directly in the search bar if you're on mobile.\n\n### \u003ckbd\u003edef\u003c/kbd\u003e get()\n\n```python\nget(url: str, **requests_kwargs) -\u003e WikivoyageSections\n```\n\nFetches a Wikivoyage page and parses it into Markdown.\n\n**Args**:\n- url (str): The URL.\n- \\*\\*requests_kwargs: Keyword-only arguments to pass into `requests.get`.\n\n**Returns**:\u003cbr /\u003e\nWikivoyageSections: Wikivoyage sections.\n\n### \u003ckbd\u003edataclass\u003c/kbd\u003e WikivoyageSections\n\nRepresents all the Wikivoyage sections. *(manually-created)*\n\n```python\nclass WikivoyageSections:\n    url: str  # The request URL\n    sections: List[Section]  # Sections\n```\n\n### \u003ckbd\u003edataclass\u003c/kbd\u003e Section\n\nRepersents a Wikivoyage section. *(manually-created)*\n\n```python\nclass Section:\n    title: str  # The title. Alias: `section`\n    content: str  # The content. Alias: `markdown`\n```\n\n## Contributing\n\nContributions are welcome! And yes, I'm not really familiar with GitHub so please help me.\n\n## License\n\nMIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faweirddev%2Fwikivoyage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faweirddev%2Fwikivoyage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faweirddev%2Fwikivoyage/lists"}