From 85a0de8123ea69607a6598756e7e6dd2dab2f7df Mon Sep 17 00:00:00 2001 From: Dima Gerasimov Date: Tue, 17 Mar 2020 19:55:53 +0000 Subject: [PATCH] delete duplicate readme --- doc/SETUP.org | 98 ++------------------------------------------------- 1 file changed, 2 insertions(+), 96 deletions(-) diff --git a/doc/SETUP.org b/doc/SETUP.org index 9df5a24..6bfce94 100644 --- a/doc/SETUP.org +++ b/doc/SETUP.org @@ -1,101 +1,7 @@ +# TODO hmm, preamble? +# TODO hci?? [[https://circleci.com/gh/karlicoss/my/tree/master][https://circleci.com/gh/karlicoss/my/tree/master.svg?style=svg]] -Python interface into my life. - -In short, this package provides programmatic access to my personal data and knowledge. -Gory details of getting data, parsing, etc. are abstracted away and you get nice and familiar Python objects. -It makes it easier to access, work with, analyze and combine data and leverage on existing libraries for data analysis like Pandas, Matplotlib, etc. - -This particular setup might not necessarily be most convenient for you to use, perhaps it's more of a concept of how you can organize, access and use personal data. -But it definitely works for me, so hopefully that would help you and serve as as source of inspiration. - -The readme is more of a setup manual, I'm writing about motivation and specific usecases [[https://beepb00p.xyz/mypkg.html][here]]. -Short example to give you an idea: "which subreddits I find most interesting?" - -#+begin_src python :python "with_my python3" :exports both - from my.reddit import get_saves - from collections import Counter - saves = get_saves() - return Counter(s.subreddit for s in saves).most_common(3) -#+end_src - -#+RESULTS: -| orgmode | 46 | -| AskReddit | 31 | -| QuantifiedSelf | 30 | - -* Supported modules - -#+begin_src python :results output table drawer :exports results :python "with_my python3" -from pathlib import Path -import re -import importlib - -def ignored(m: str): - excluded = [ - 'kython.*', - 'bluemaestro.check', - 'body', - 'books', - 'calendar', - 'coding', - 'coding.codeforces', - 'coding.topcoder', - 'media', - 'mycfg_stub', - 'reading', - 'takeout', - '_rss', - 'common', - 'error', - ] - exs = '|'.join(excluded) - return re.match(f'^my.({exs})$', m) - -for f in list(sorted(Path('my/').glob('**/*.py'))): - if f.is_symlink(): - continue # meh - if f.name == '__init__.py': - f = f.parent - m = str(f.with_suffix('')).replace('/', '.') - if ignored(m): - continue - # TODO module link? - # TODO I've done this for infra diagram already... - mod = importlib.import_module(m) - doc = mod.__doc__ - if doc is None: - pass # TODO - # print(m, ": NO DOCS!") - continue - else: - fline = doc.strip().splitlines()[0] - mlink = f'[[{f}][{m}]]' - print('|', mlink, '|', fline, '|') - -#+end_src - -#+RESULTS: -:results: -| [[my/bluemaestro][my.bluemaestro]] | Bluemaestro temperature/humidity/pressure monitor | -| [[my/body/blood.py][my.body.blood]] | Blood tracking | -| [[my/books/kobo.py][my.books.kobo]] | Kobo e-ink reader: annotations and reading stats | -| [[my/calendar/holidays.py][my.calendar.holidays]] | Provides data on days off work (based on public holidays + manual inputs) | -| [[my/coding/github.py][my.coding.github]] | Github events and their metadata: comments/issues/pull requests | -| [[my/fbmessenger.py][my.fbmessenger]] | Module for Facebook Messenger messages | -| [[my/feedbin.py][my.feedbin]] | Module for Feedbin RSS reader | -| [[my/feedly.py][my.feedly]] | Module for Fedly RSS reader | -| [[my/hypothesis.py][my.hypothesis]] | Hypothes.is highlights and annotations | -| [[my/instapaper.py][my.instapaper]] | Instapaper bookmarks, highlights and annotations | -| [[my/location/takeout.py][my.location.takeout]] | Module for Google Takeout data | -| [[my/materialistic.py][my.materialistic]] | Module for [[https://play.google.com/store/apps/details?id=io.github.hidroh.materialistic][Materialistic]] app for Hackernews | -| [[my/pinboard.py][my.pinboard]] | Module for pinboard.in bookmarks | -| [[my/reading/polar.py][my.reading.polar]] | Module for Polar articles and highlights | -| [[my/reddit.py][my.reddit]] | Module for Reddit data: saved items/comments/upvotes etc | -| [[my/twitter.py][my.twitter]] | Module for Twitter (uses official twitter archive export) | -:end: - - * Setting up ** =mycfg= package for private paths/repositories (optional)