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: API to access Zotero DB #82

Open
stefanopagliari opened this issue Nov 3, 2022 · 13 comments
Open

Feature: API to access Zotero DB #82

stefanopagliari opened this issue Nov 3, 2022 · 13 comments
Labels
enhancement New feature or request

Comments

@stefanopagliari
Copy link

Thank you for this great plugin. The integration with the Zotero DB in the Zotero Plugin works great. As mentioned in Discord it would be helpful (at least for me but I'm sure also for others) if you considered introducing an API or some other mechanism to allow other plugins to read the Zotero DB. Thanks

@stefanopagliari
Copy link
Author

@aidenlx sorry to bother you about this. I was wondering if you could provide any suggestion on how it could be possible to read the Zotero DB from another plugin. My attempts to integrate sqlite into my plugin have hit a wall

@aidenlx
Copy link
Member

aidenlx commented Feb 20, 2023

Sorry for the long wait! The next major update obsidian plugin will arrive in two week or so. I've been busy with the work and refactoring the plugin. Can you first try describe the needs for the API?

could provide any suggestion on how it could be possible to read the Zotero DB from another plugin

I'm using a custom build of better-sqlite3, and download binaries for the github release based on machine's architecture. I've put database instance inside worker so that reading db won't block UI. The core logic for init database instance can be found here, Although I still recommend you to use API exposed from this plugin in next version:

https://github.com/aidenlx/obsidian-zotero/blob/dev/lib/db-worker/src/database.ts

@FeralFlora
Copy link

@stefanopagliari The update is out now!

@stefanopagliari
Copy link
Author

@aidenlx @MSBack
Thank you for this.
Sorry for not seeing before your message from February 20.
Ideally I would like a way for other plugins to be able to run searches on the Zotero DB once your plugin is installed and activated.

@FeralFlora
Copy link

FeralFlora commented Mar 24, 2023

Ideally I would like a way for other plugins to be able to run searches on the Zotero DB once your plugin is installed and activated.

Isn't that what this new update (1.0.0) does? The changelog says:

forward API to global window property zoteroAPI for other plugins to use.

@aidenlx aidenlx added the enhancement New feature or request label Mar 24, 2023
@aidenlx
Copy link
Member

aidenlx commented Mar 24, 2023

the search function is not yet available, and currently available APIs is listed in here: https://obzt.aidenlx.top/reference/api/interfaces/PluginAPI

@aidenlx aidenlx changed the title API to access Zotero DB Feature: API to access Zotero DB Mar 24, 2023
@FeralFlora
Copy link

Hey @aidenlx, is the Zotlit API still available? The documentation link above is dead, and I can't find anything about it in the new docs. I am interested in using the API to develop a plugin that provides some Zotero related workflows.

@aidenlx
Copy link
Member

aidenlx commented Sep 11, 2023

Yes, it's still there, it's just that I haven't migrate that part to new docs. I'll see if API doc generation is still feasible in new document framework.

@github-actions
Copy link

This issue is stale because it has been open for 14 days with no activity.

@github-actions github-actions bot added the stale label Sep 28, 2023
@FeralFlora
Copy link

Yes, it's still there, it's just that I haven't migrate that part to new docs. I'll see if API doc generation is still feasible in new document framework.

Will you give an update here when the API docs are back?

@github-actions github-actions bot removed the stale label Sep 29, 2023
@github-actions
Copy link

This issue is stale because it has been open for 14 days with no activity.

@github-actions github-actions bot added the stale label Oct 13, 2023
@FeralFlora
Copy link

Bump

@github-actions github-actions bot removed the stale label Oct 14, 2023
@FeralFlora
Copy link

Any update on the Zotlit API?

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

No branches or pull requests

3 participants