{"id":15058976,"url":"https://github.com/mkuranowski/pyroutelib3","last_synced_at":"2025-08-20T22:32:15.225Z","repository":{"id":25805148,"uuid":"104753764","full_name":"MKuranowski/pyroutelib3","owner":"MKuranowski","description":"Simple routing over OpenStreetMap data","archived":false,"fork":false,"pushed_at":"2024-07-28T16:56:42.000Z","size":351,"stargazers_count":84,"open_issues_count":2,"forks_count":24,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-07-03T22:48:54.905Z","etag":null,"topics":["openstreetmap","osm","python3-library","router"],"latest_commit_sha":null,"homepage":"https://pyroutelib3.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MKuranowski.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-25T13:30:08.000Z","updated_at":"2025-07-02T06:45:03.000Z","dependencies_parsed_at":"2022-08-07T11:16:01.441Z","dependency_job_id":null,"html_url":"https://github.com/MKuranowski/pyroutelib3","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/MKuranowski/pyroutelib3","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MKuranowski%2Fpyroutelib3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MKuranowski%2Fpyroutelib3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MKuranowski%2Fpyroutelib3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MKuranowski%2Fpyroutelib3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MKuranowski","download_url":"https://codeload.github.com/MKuranowski/pyroutelib3/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MKuranowski%2Fpyroutelib3/sbom","scorecard":{"id":87723,"data":{"date":"2025-08-11","repo":{"name":"github.com/MKuranowski/pyroutelib3","commit":"313dfc2a52b91be9feed4653cd33a1e8e9a5a83d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/check.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/MKuranowski/pyroutelib3/check.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/MKuranowski/pyroutelib3/check.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/check.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/MKuranowski/pyroutelib3/check.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/MKuranowski/pyroutelib3/check.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/MKuranowski/pyroutelib3/check.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/check.yml:18","Warn: pipCommand not pinned by hash: .github/workflows/check.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/check.yml:33","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-8qvm-5x2c-j2w7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-15T07:17:19.112Z","repository_id":25805148,"created_at":"2025-08-15T07:17:19.112Z","updated_at":"2025-08-15T07:17:19.112Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271397965,"owners_count":24752641,"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-20T02:00:09.606Z","response_time":69,"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":["openstreetmap","osm","python3-library","router"],"created_at":"2024-09-24T22:34:47.660Z","updated_at":"2025-08-20T22:32:14.974Z","avatar_url":"https://github.com/MKuranowski.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pyroutelib3\n\n\u003c!-- This file must be kept in sync with docs/index.rst --\u003e\n\n[GitHub](https://github.com/MKuranowski/pyroutelib3) |\n[Documentation](https://pyroutelib3.readthedocs.io/) |\n[Issue Tracker](https://github.com/MKuranowski/pyroutelib3/issues) |\n[PyPI](https://pypi.org/project/pyroutelib3/)\n\nSimple routing over OSM data.\n\npyroutelib3 is a Python library for simple routing over\n[OpenStreetMap](https://openstreetmap.org) data.\n\n```py\nimport pyroutelib3\n\nlive_graph = pyroutelib3.osm.LiveGraph(pyroutelib3.osm.CarProfile())\n\nstart_node = live_graph.find_nearest_node((52.23201, 21.00737))\nend_node = live_graph.find_nearest_node((52.24158, 21.02807))\n\nroute = pyroutelib3.find_route_without_turn_around(live_graph, start_node.id, end_node.id)\nroute_lat_lons = [live_graph.get_node(node).position for node in route]\n```\n\nThe example above uses `osm.LiveGraph`, which automatically downloads OpenStreetMap data in tiles\nand caches them on your disk. It is much more wise to download the data beforehand from a service\nlike [Geofabrik OSM data extracts](https://download.geofabrik.de/):\n\n```py\nimport pyroutelib3\n\nwith open(\"mazowieckie-latest.osm.pbf\", \"rb\") as f:\n    graph = pyroutelib3.osm.Graph.from_file(pyroutelib3.osm.CarProfile(), f)\n\nstart_node = graph.find_nearest_node((52.23201, 21.00737))\nend_node = graph.find_nearest_node((52.24158, 21.02807))\n\nroute = pyroutelib3.find_route_without_turn_around(graph, start_node, end_node)\nroute_lat_lons = [graph.get_node(node).position for node in route]\n```\n\npyroutelib3 not only is able to parse OpenStreetMap data into a graph (see the `osm` module),\nbut also contains generic implementations of the A* path-finding algorithm (`find_route` and\n`find_route_without_turn_around` functions) and the k-d tree data structure (`KDTree` class).\n\nThis library was designed with extensibility in mind, and most components can be swapped for\ncompletely custom ones through the usage of well-defined protocols. As an example,\na `nx.GraphAdaptor` is provided to use [networkx graphs](https://networkx.org/documentation/stable/reference/introduction.html#graphs)\nwith pyroutelib3's functionality.\n\n\n## Installation\n\n```\npip install --upgrade pyroutelib3\n```\n\npyroutelib3 uses [semantic versioning](https://semver.org/). Always specify dependencies on\nthis library with a constraint on the major revision, e.g. `pyroutelib3 ~= 2.0.0`.\n\nNote that version 1 of this library is incompatible with version 2.\n\n\n## Features\n\n- Generic A* algorithm implementation (`find_route` and `find_route_without_turn_around` functions)\n- Generic graph data structure (`SimpleGraph` class)\n- Generic k-d data structure (`KDTree` class)\n- Extensibility through usage of well-defined protocols (`protocols` module)\n    - [networkx](https://networkx.org/) compatibility (`nx.GraphAdaptor` and\n        `nx.ExternalGraphAdaptor` classes)\n- [OSM XML](https://wiki.openstreetmap.org/wiki/OSM_XML) and [OSM PBF](https://wiki.openstreetmap.org/wiki/PBF_Format\u003e)\n    file parsing (`osm.reader.read_features` function)\n- Converting [OpenStreetMap data](https://openstreetmap.org/) into a usable graph (`osm.Graph` class)\n    - High customizability of the process through the usage of different profiles.\n    - Expressing way preferences through the usage of penalties for unpreferred tags\n    - Respecting [access restrictions](https://wiki.openstreetmap.org/wiki/Key:access) on ways\n    - Support for [turn restrictions](https://wiki.openstreetmap.org/wiki/Relation:restriction\u003e),\n        including `restriction:TRANSPORT` and `exempt` tags\n    - Downloading data on-the-fly (`osm.LiveGraph` class)\n\n\n## License\n\npyroutelib3 is distributed under GNU GPL v3 (or any later version).\n\n\u003e © Copyright 2024 Mikołaj Kuranowski\n\u003e\n\u003e pyroutelib3 is free software: you can redistribute it and/or modify\n\u003e it under the terms of the GNU General Public License as published by\n\u003e the Free Software Foundation; either version 3 of the License, or\n\u003e (at your option) any later version.\n\u003e\n\u003e pyroutelib3 is distributed in the hope that it will be useful,\n\u003e but WITHOUT ANY WARRANTY; without even the implied warranty of\n\u003e MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n\u003e GNU General Public License for more details.\n\u003e\n\u003e You should have received a copy of the GNU General Public License\n\u003e along with pyroutelib3. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkuranowski%2Fpyroutelib3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkuranowski%2Fpyroutelib3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkuranowski%2Fpyroutelib3/lists"}