Giter Club home page Giter Club logo

hypexport's Introduction

Export/takeout for your personal Hypothes.is data: annotations and profile information.

Setting up

  1. The easiest way is pip3 install --user git+https://github.com/karlicoss/hypexport.

    Alternatively, use git clone --recursive, or git pull && git submodules update --init. After that, you can use pip3 install --editable.

  2. Follow these instructions to set up the token

Exporting

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 <username> --token <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!

hypexport's People

Contributors

karlicoss avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

hypexport's Issues

hypexport returns global info only

I simply tested it like this.

python3 -m hypexport.export --username "SOME_ID" --token "SOME_TOKEN" > hypothesis.json
{
  "annotations": [],
  "profile": {
    "authority": "hypothes.is",
    "features": {
      "client_display_names": false,
      "embed_cachebuster": false,
      "notebook_launch": true
    },
    "groups": [
      {
        "id": "__world__",
        "name": "Public",
        "public": true
      },
      {
        "id": "OMITTED",
        "name": "Audio signal analysis",
        "public": false,
        "url": "https://hypothes.is/groups/OMITTED/audio-signal-analysis"
      },
      {
        "id": "OMITTED",
        "name": "Data science",
        "public": false,
        "url": "https://hypothes.is/groups/OMITTED/data-science"
      },
      {
        "id": "OMITTED",
        "name": "General",
        "public": false,
        "url": "https://hypothes.is/groups/OMITTED/general"
      }
    ],
    "preferences": {},
    "user_info": {
      "display_name": null
    },
    "userid": "acct:[email protected]"
  }
}                         

This output differs from annotation.json of HPI demo.

I saw your comment.
Is the hypothesis annotation structure changed?
Or do I have to change some settings in hypothesis?

No module named 'hypexport'

Hi! I want to use hypothesis module with orger.
I run first: pip3 install --user git+https://github.com/karlicoss/hypexport
Then I create secrets.py containing my username and token.
Then I run python3 -m hypexport.export --secrets /path/to/secrets.py

However, I get:
/usr/local/anaconda3/bin/python3: Error while finding module specification for 'hypexport.export' (ModuleNotFoundError: No module named 'hypexport')

Error when running

Hi I'm trying to run this and it seems as though the repo is missing some things. There is only a requirements-dev.txt though the README calls out a requirements.txt. In addition the requirements file is missing requests as a dependency.

[Feature] Timezone edit feature

Hi, I was trying to currently export things from hypothesis to Org Mode, and I found the Orger module. (Awesome work ๐Ÿ‘ )
I was wondering if it was possible to modify or specify time zone, cause by default it shows UTC.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.