103 lines
3.8 KiB
Org Mode
103 lines
3.8 KiB
Org Mode
# TODO FAQ??
|
|
Please don't be shy and raise issues if something in the instructions is unclear.
|
|
You'd be really helping me, I want to make the setup as straightforward as possible!
|
|
|
|
* Setting up
|
|
** [optional] private configuration (=my.config=)
|
|
If you're not planning to use private configuration (some modules don't need it) you can skip straight to the next step. Still, I'd recommend you to read anyway.
|
|
|
|
First you need to tell the package where to look for your data and external repositories, which is done though a separate (private) package named ~mycfg~.
|
|
|
|
You can see example in ~mycfg_template~. You can copy it somewhere else and modify to your needs.
|
|
|
|
Some explanations:
|
|
|
|
#+begin_src bash :exports results :results output
|
|
for x in $(find mycfg_template/ | grep -v -E 'mypy_cache|.git|__pycache__|scignore'); do
|
|
if [[ -L "$x" ]]; then
|
|
echo "l $x -> $(readlink $x)"
|
|
elif [[ -d "$x" ]]; then
|
|
echo "d $x"
|
|
else
|
|
echo "f $x"
|
|
(echo "---"; cat "$x"; echo "---" ) | sed 's/^/ /'
|
|
fi
|
|
done
|
|
#+end_src
|
|
|
|
#+RESULTS:
|
|
#+begin_example
|
|
d mycfg_template/
|
|
d mycfg_template/mycfg
|
|
f mycfg_template/mycfg/__init__.py
|
|
---
|
|
class paths:
|
|
"""
|
|
Feel free to remove this if you don't need it/add your own custom settings and use them
|
|
"""
|
|
class hypothesis:
|
|
export_path = '/tmp/my_demo/backups/hypothesis'
|
|
---
|
|
d mycfg_template/mycfg/repos
|
|
l mycfg_template/mycfg/repos/hypexport -> /tmp/my_demo/hypothesis_repo
|
|
#+end_example
|
|
|
|
As you can see, generally you specify fixed paths (e.g. to backup directory) in ~__init__.py~.
|
|
Feel free to add other files as well though to organize better, it's a real python package after all!
|
|
|
|
Some things (e.g. links to external packages like [[https://github.com/karlicoss/hypexport][hypexport]]) are specified as normal symlinks in ~repos~ directory.
|
|
That way you get easy imports (e.g. =import mycfg.repos.hypexport.model=) and proper IDE integration.
|
|
|
|
# TODO link to post about exports?
|
|
** =with_my= helper script
|
|
# TODO FIXME dependencies?
|
|
# At the moment the package is not uploaded to PyPi yet, so can't
|
|
# TODO update this section
|
|
Next, point =with_my= script to your private configuration:
|
|
|
|
#+begin_src bash
|
|
cp with_my.example with_my
|
|
vim with_my # specify path to your mycfg (if you want to use it)
|
|
#+end_src
|
|
|
|
It's also convenient to put =with_my= somewhere in your system path so you can run it from anywhere.
|
|
|
|
** Dependencies
|
|
Dependencies are different for specific modules you're planning to use, so it's hard to specify.
|
|
Generally you can just try using the module and then install missing packages via ~pip install --user~, should be fairly straightforward.
|
|
|
|
* Usage examples
|
|
If you run your script with ~with_my~ wrapper, you'd have ~my~ in ~PYTHONPATH~ which gives you access to your data from within the script.
|
|
|
|
** Kobo reader
|
|
Kobo provider allows you access the books you've read along with the highlights and notes.
|
|
It uses exports provided by [[https://github.com/karlicoss/kobuddy][kobuddy]] package.
|
|
|
|
- prepare the config
|
|
|
|
1. Point =ln -sfT /path/to/kobuddy ~/.config/my/config/repos/kobuddy=
|
|
2. Add kobo config to =~/.config/my/config/__init__.py=
|
|
#+begin_src python
|
|
class kobo:
|
|
export_dir = 'path/to/kobo/exports'
|
|
#+end_src
|
|
|
|
After that you should be able to use it:
|
|
|
|
#+begin_src bash
|
|
with_my python3 -c 'import my.books.kobo as kobo; print(kobo.get_highlights())'
|
|
#+end_src
|
|
|
|
** Orger
|
|
You can use [[https://github.com/karlicoss/orger][orger]] to get Org-mode representations of your data.
|
|
|
|
Some examples:
|
|
|
|
*** [[https://github.com/burtonator/polar-bookshelf][Polar]]
|
|
This will convert Polar highlights into org-mode:
|
|
#+begin_src bash
|
|
with_my orger/modules/polar.py --to polar.org
|
|
#+end_src
|
|
|
|
** =demo.py=
|
|
read/run [[../demo.py][demo.py]] for a full demonstration of setting up Hypothesis (it uses public annotations data from Github)
|