add demo; proper readme; remove kython dependencies

demo.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python3
+from subprocess import check_call, DEVNULL
+from shutil import copy, copytree
+import os
+import tempfile
+from pathlib import Path
+
+my_repo = Path(__file__).absolute().parent
+
+
+def run():
+    # clone git@github.com:karlicoss/my.git
+    copytree(my_repo, 'my_repo')
+
+    # prepare repositories you'd be using. For this demo we only set up Hypothesis
+    hypothesis_repo = os.path.abspath('hypothesis_repo')
+    check_call(['git', 'clone', 'https://github.com/karlicoss/hypexport.git', hypothesis_repo])
+    #
+
+
+    # prepare some demo Hypothesis data
+    hypothesis_backups = os.path.abspath('backups/hypothesis')
+    Path(hypothesis_backups).mkdir(exist_ok=True, parents=True)
+    check_call([
+        'curl',
+        'https://raw.githubusercontent.com/taniki/netrights-dashboard-mockup/master/_data/annotations.json',
+        '-o', hypothesis_backups + '/annotations.json',
+    ], stderr=DEVNULL)
+    #
+
+
+    # create private configuration and set necessary paths
+    with_my = 'my_repo/with_my'
+    copy('my_repo/with_my.example', with_my)
+
+    private_config = os.path.abspath('my_configuration.py')
+    Path(private_config).write_text("""
+
+class paths:
+    class hypexport:
+        repo       = '{hypothesis_repo}'
+        export_dir = '{hypothesis_backups}'
+
+""".format(**locals()))
+    #
+
+    # edit the config and set path to private configuration
+    my = Path(with_my).read_text().replace('MY_CONFIGURATION_PATH=', 'MY_CONFIGURATION_PATH=' + private_config)
+    Path(with_my).write_text(my)
+    #
+
+
+    # now we can use it!
+
+    check_call(['my_repo/with_my', 'python3', '-c', '''
+import my.hypothesis
+
+from pprint import pprint
+
+for page in my.hypothesis.get_pages()[:8]:
+    print('URL:   ' + page.link)
+    print('Title: ' + page.title)
+    print('{} annotations'.format(len(page.annotations)))
+    print()
+'''])
+
+# that should result in something like this:
+
+# URL:   https://tacticaltech.org/
+# Title: Tactical Technology Collective
+# 1 annotations
+#
+# URL:   https://web.hypothes.is/blog/annotating-the-wild-west-of-information-flow/
+# Title: Annotating the wild west of information flow – Hypothesis
+# 1 annotations
+#
+# URL:   http://www.liberation.fr/futurs/2016/12/12/megafichier-beauvau-prie-de-revoir-sa-copie_1534720
+# Title: «Mégafichier» : Beauvau prié de revoir sa copie
+# 3 annotations
+#
+# URL:   https://www.wired.com/2016/12/7500-faceless-coders-paid-bitcoin-built-hedge-funds-brain/
+# Title: 7,500 Faceless Coders Paid in Bitcoin Built a Hedge Fund’s Brain
+# 4 annotations
+#
+# URL:   http://realscreen.com/2016/12/06/project-x-tough-among-sundance-17-doc-shorts/
+# Title: “Project X,” “Tough” among Sundance ’17 doc shorts
+# 1 annotations
+#
+# URL:   https://grehack.fr/2016/program
+# Title: GreHack | Security conference and hacking game 2016 | Grenoble
+# 1 annotations
+#
+# URL:   https://respectmynet.eu/
+# Title: [!] Respect My Net
+# 1 annotations
+#
+# URL:   https://www.youtube.com/watch?v=Xgp7BIBtPhk
+# Title: BBC Documentaries 2016: The Joy of Data [FULL BBC SCIENCE DOCUMENTARY]
+# 1 annotations
+
+
+
+def main():
+    with tempfile.TemporaryDirectory() as tdir:
+        os.chdir(tdir)
+        run()
+
+
+if __name__ == '__main__':
+    main()