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

Document API for grasp/server #41

Closed
snoblenet opened this issue Jan 12, 2022 · 2 comments
Closed

Document API for grasp/server #41

snoblenet opened this issue Jan 12, 2022 · 2 comments

Comments

@snoblenet
Copy link

snoblenet commented Jan 12, 2022

Thanks for Grasp.

It is possible for you to briefly document the API for grasp/server?

I can picture myself hitting it with a range of personal tools other than the browser extension.

@karlicoss
Copy link
Owner

Hi!
You can basically see what the 'API' is here: https://github.com/karlicoss/grasp/blob/master/server/test_grasp.py#L27-L41

So essentially just a bunch of fields passed in a post request. IMO there is no good reason to use Grasp outside the browser, it's just easier to construct a bit of org-mode and append it to a file. This is basically all that Grasp server does: https://github.com/karlicoss/grasp/blob/master/server/grasp_server.py#L80-L92

The bit that possibly could be reused in other tools is the code that can generate org-mode here https://github.com/karlicoss/grasp/blob/master/server/org_tools.py . There is also some relevant discussion in orgparse karlicoss/orgparse#11

@snoblenet
Copy link
Author

Thanks.

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

No branches or pull requests

2 participants