{"id":15011022,"url":"https://github.com/aatmunbaxi/orgroamtools","last_synced_at":"2025-04-09T18:41:46.156Z","repository":{"id":213019671,"uuid":"731437922","full_name":"aatmunbaxi/orgroamtools","owner":"aatmunbaxi","description":"Helper library for data analysis of org-roam collections","archived":false,"fork":false,"pushed_at":"2024-09-15T19:02:58.000Z","size":3555,"stargazers_count":28,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T20:43:28.055Z","etag":null,"topics":["data-science","emacs","exploratory-data-analysis","library","org-roam","personal-knowledge-management","python"],"latest_commit_sha":null,"homepage":"https://aatmunbaxi.github.io/orgroamtools/","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/aatmunbaxi.png","metadata":{"files":{"readme":"README.org","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-12-14T04:46:33.000Z","updated_at":"2025-03-04T14:22:46.000Z","dependencies_parsed_at":"2023-12-23T22:17:04.178Z","dependency_job_id":"c22c6952-5cb0-4691-8bbf-aea030969692","html_url":"https://github.com/aatmunbaxi/orgroamtools","commit_stats":null,"previous_names":["aatmunbaxi/orgroamtools"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aatmunbaxi%2Forgroamtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aatmunbaxi%2Forgroamtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aatmunbaxi%2Forgroamtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aatmunbaxi%2Forgroamtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aatmunbaxi","download_url":"https://codeload.github.com/aatmunbaxi/orgroamtools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248089969,"owners_count":21046002,"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":["data-science","emacs","exploratory-data-analysis","library","org-roam","personal-knowledge-management","python"],"created_at":"2024-09-24T19:38:29.278Z","updated_at":"2025-04-09T18:41:46.135Z","avatar_url":"https://github.com/aatmunbaxi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+title: orgroamtools 📓🔬\n\n[[file:viz/COVER.svg]]\n\n=orgroamtools= is a Python library to assist in data analysis of =org-roam= collection, written in as close to pure Python as possible.\nIt can pull various bits of information out of your =org-roam=, including some body-text based information like source blocks and LaTeX snippets.\nThe information you extract about the natural graph structure of your collection can be used for many types of exploratory data analysis involving graph neural networks, natural language processing, and topological data analysis.\n\nTo use it, all you need is a healthy =org-roam v2= database!\nTake a minute to locate the database by inspecting the value of =(org-roam-db-location)= in Emacs, then make sure it is up to date by running =(org-roam-db-sync)=.\n\n* Getting Started\nInstall the library, putting it in a virtual environment if desired:\n#+begin_src sh\npython -m pip install orgroamtools\n#+end_src\nImport the library and pass in your database path:\n#+begin_src python\nfrom orgroamtools.data import RoamGraph\ncollection = RoamGraph(PATH_TO_ORG_ROAM_DB)\n#+end_src\n\nYou can extract the graph structure via adjacency lists for use in graph data analysis methods like GNNs and TDA:\n#+begin_src python\ngraph = collection.adjacency_list\n#+end_src\nOr you can extract the body texts of the nodes for text preprocessing for NLP:\n#+begin_src python\nnode_bodies = collection.body_index\n#+end_src\n\nFull documentation of functions and features for the library can be read [[https://aatmunbaxi.github.io/orgroamtools][here]].\n* Dependencies\n- Python 3.10+\n- =networkx=: a graph analysis library for Python\n- =orgparse=: a Python library for parsing =org-mode= files\n* Related\n- =obsidiantools=\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faatmunbaxi%2Forgroamtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faatmunbaxi%2Forgroamtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faatmunbaxi%2Forgroamtools/lists"}