{"id":15447529,"url":"https://github.com/datadavev/arkr","last_synced_at":"2025-03-28T08:44:24.486Z","repository":{"id":176925990,"uuid":"629578204","full_name":"datadavev/arkr","owner":"datadavev","description":"Minimal ARK NAAN resolver with introspection","archived":false,"fork":false,"pushed_at":"2023-06-29T18:57:11.000Z","size":26,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T09:27:41.089Z","etag":null,"topics":["identifier"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datadavev.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":"2023-04-18T15:36:43.000Z","updated_at":"2023-08-28T17:34:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f2d0c24-2d24-41d7-9e11-a777f2b584eb","html_url":"https://github.com/datadavev/arkr","commit_stats":null,"previous_names":["datadavev/arkr"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datadavev%2Farkr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datadavev%2Farkr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datadavev%2Farkr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datadavev%2Farkr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datadavev","download_url":"https://codeload.github.com/datadavev/arkr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245999318,"owners_count":20707554,"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":["identifier"],"created_at":"2024-10-01T20:06:53.540Z","updated_at":"2025-03-28T08:44:24.480Z","avatar_url":"https://github.com/datadavev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ARKR\n\nA simple ARK NAAN resolver service.\n\nARKR is a minimalist ARK NAAN resolver service that supports redirection to \nregistered NAAN targets or introspection (inflection) of a NAAN public record.\n\nRequires a JSON copy of the NAAN public registry information, such as produced \nby `naan_reg_json`.\n\n## Operation\n\nTo run ARKR locally, setup your python virtual environment then:\n\n```\npip install -r backend/requirements.txt\n```\n\nRetrieve the NAAN records as json (currently requires a local copy of `main_naans`):\n\n```\npython ../naan_reg_json/naan_reg_json.py -p -f backend/naans ../naan_reg_priv/main_naans\n```\n\nThen run the service:\n```\ncd backend\nuvicorn main:app\n```\n\nThe service may be deployed to any service supporting python WSGI such as Vercel. For example:\n\n```\nvercel deploy\n```\n\nAn example of the service running on Vercel is available at: https://arkr.vercel.app/\n\n## Service Endpoints\n\n| Path                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                      |\n|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [`/docs`](https://arkr.vercel.app/docs) | API documentation                                                                                                                                                                                                                                                                                                                                                                                                |\n| `/diag/{IDENTIFIER}`                             | Presents some diagnostics of request processing. E.g. [diag/ark:/12148/bpt6k10733944](https://arkr.vercel.app/diag/ark:/12148/bpt6k10733944)                                                                                                                                                                                                                                                                |\n| `/{IDENTIFIER}`                                  | Redirects to supplied ARK. \u003cbr\u003e* [`/ark:/12148/bpt6k10733944`](https://arkr.vercel.app/ark:/12148/bpt6k10733944) \u003cbr\u003e* [`/ark:12148/bpt6k10733944`](https://arkr.vercel.app/ark:12148/bpt6k10733944) \u003cbr\u003e* [`/12148/bpt6k10733944`](https://arkr-1-v3111276.deta.app/12148/bpt6k10733944)                                                                                                              |\n| `/{NAAN}[/][?? \\| ?info]`                        | Returns metadata about the NAAN. Note that if characters beyond a terminating \"/\" are included then the response is a redirect to the registered location with the provided inflection request. \u003cbr\u003e* [`/ark:/12148/?info`](https://arkr.vercel.app/ark:/12148/?info) \u003cbr\u003e* [`/ark:12148??`](https://arkr.vercel.app/ark:12148??) \u003cbr\u003e* [`/12148/?info`](https://arkr.vercel.app/12148??) |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatadavev%2Farkr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatadavev%2Farkr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatadavev%2Farkr/lists"}