Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Retrieve All Note Paths via Socket #14

Open
mathe00 opened this issue Oct 5, 2024 · 1 comment
Open

Feature Request: Retrieve All Note Paths via Socket #14

mathe00 opened this issue Oct 5, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@mathe00
Copy link
Owner

mathe00 commented Oct 5, 2024

Description
It would be very useful to implement a feature that retrieves the paths of all notes within the Obsidian vault and transmits them through the existing Unix socket connection. This would allow Python scripts to access the indexed notes directly from Obsidian’s cache, avoiding the need to manually scan the vault file system in Python. This feature can improve efficiency for plugin users who wish to manipulate or automate tasks involving multiple notes.

Proposed Solution

  • Add a new method to fetch the paths of all notes in the vault using this.app.vault.getFiles().
  • Implement a socket action (get_all_note_paths) to transmit these note paths to Python scripts.
  • Ensure that the response includes a JSON object with the list of note paths.

Use Case
This feature would be helpful for users needing a quick and efficient way to interact with multiple notes in Python without having to perform filesystem operations, which can slow down processes and add unnecessary complexity.

@mathe00 mathe00 self-assigned this Oct 5, 2024
@mathe00 mathe00 added the enhancement New feature or request label Oct 5, 2024
@mathe00
Copy link
Owner Author

mathe00 commented Oct 5, 2024

I’ll be implementing a simple but very useful feature soon that will allow Python scripts to retrieve all note paths in the vault via the Unix socket. This will avoid the need to manually scan the vault’s filesystem in Python, leveraging Obsidian’s built-in metadata cache instead. Expect this feature to be available shortly—it's straightforward and will improve efficiency for multi-note operations.

Stay tuned for updates!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant