https://github.com/karlicoss/hypexport
Export/access your Hypothes.is data: annotations and profile info
https://github.com/karlicoss/hypexport
backup data-liberation export hypothesis takeout
Last synced: 3 months ago
JSON representation
Export/access your Hypothes.is data: annotations and profile info
- Host: GitHub
- URL: https://github.com/karlicoss/hypexport
- Owner: karlicoss
- License: mit
- Created: 2019-09-23T00:41:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T23:40:27.000Z (5 months ago)
- Last Synced: 2025-04-02T20:05:08.559Z (3 months ago)
- Topics: backup, data-liberation, export, hypothesis, takeout
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 43
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - karlicoss/hypexport - Export/access your Hypothes.is data: annotations and profile info (others)
README
#+begin_src python :dir src :results drawer :exports results
import hypexport.export as E; return E.make_parser().prog
#+end_src
#+RESULTS:
:results:
Export/takeout for your personal [[https://hypothes.is][Hypothes.is]] data: annotations and profile information.
:end:
* Setting up
1. install with PIP
- =pip3 install --user git+https://github.com/karlicoss/hypexport=
- for export functionality: append =[export]=
- for optional extras for logging and faster json processing: append =[optional]=
- or any combination of the above, e.g. =[export,optional]=
- alternatively, use =git clone --recursive=, or =git pull && git submodules update --init=. After that, you can use =pip3 install --editable=.
2. Follow [[https://hypothes.is/account/developer][these]] instructions to set up the token
* Exporting
#+begin_src python :dir src :results drawer :exports results
import hypexport.export as E; return E.make_parser().epilog
#+end_src
#+RESULTS:
:results:
Usage:
*Recommended*: create =secrets.py= keeping your api parameters, e.g.:
: username = "USERNAME"
: token = "TOKEN"
After that, use:
: python3 -m hypexport.export --secrets /path/to/secrets.py
That way you type less and have control over where you keep your plaintext secrets.
*Alternatively*, you can pass parameters directly, e.g.
: python3 -m hypexport.export --username --token
However, this is verbose and prone to leaking your keys/tokens/passwords in shell history.
You can also import ~hypexport.export~ as a module and call ~get_json~ function directly to get raw JSON.
I *highly* recommend checking exported files at least once just to make sure they contain everything you expect from your export. If not, please feel free to ask or raise an issue!
:end:
# TODO FIXME api limitations 10000 annotations?