fz0x1/HPI
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update references to my.reddit

Browse source
This commit is contained in:
Sean Breckenridge 2022-01-08 19:54:39 -08:00
parent be21606075
commit 03fbdcdfbc
3 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/MODULES.org
View file

@ -139,7 +139,7 @@ for cls, p in modules:
# paths[s]/glob to the exported JSON data
export_path: Paths
#+end_src
** [[file:../my/reddit.py][my.reddit]]
** [[file:../my/reddit][my.reddit]]
Reddit data: saved items/comments/upvotes/etc.

14
my/core/__main__.py
View file

@ -105,7 +105,7 @@ def config_create() -> None:
# hpi config check
# to quickly check a specific module setup, run hpi doctor <module>, e.g.:
# hpi doctor my.reddit
# hpi doctor my.reddit.rexport
### useful default imports
from my.core import Paths, PathIsh, get_files
@ -515,7 +515,7 @@ def doctor_cmd(verbose: bool, list_all: bool, quick: bool, skip_conf: bool, modu
'''
Run various checks
MODULE is one or more specific module names to check (e.g. my.reddit)
MODULE is one or more specific module names to check (e.g. my.reddit.rexport)
Otherwise, checks all modules
'''
if not skip_conf:
@ -562,7 +562,7 @@ def module_requires_cmd(module: str) -> None:
'''
Print MODULE requirements
MODULE is a specific module name (e.g. my.reddit)
MODULE is a specific module name (e.g. my.reddit.rexport)
'''
module_requires(module=module)
@ -574,7 +574,7 @@ def module_install_cmd(user: bool, module: str) -> None:
'''
Install dependencies for a module using pip
MODULE is a specific module name (e.g. my.reddit)
MODULE is a specific module name (e.g. my.reddit.rexport)
'''
# todo could add functions to check specific module etc..
module_install(user=user, module=module)
@ -676,13 +676,13 @@ def query_cmd(
As an example, to query reddit comments I've made in the last month
\b
hpi query --order-type datetime --before now --within 4w my.reddit.comments
hpi query --order-type datetime --before now --within 4w my.reddit.all.comments
or...
hpi query --recent 4w my.reddit.comments
hpi query --recent 4w my.reddit.all.comments
\b
Can also query within a range. To filter comments between 2016 and 2018:
hpi query --order-type datetime --after '2016-01-01 00:00:00' --before '2019-01-01 00:00:00' my.reddit.comments
hpi query --order-type datetime --after '2016-01-01 00:00:00' --before '2019-01-01 00:00:00' my.reddit.all.comments
'''
from datetime import datetime, date

4
my/core/query.py
View file

@ -66,10 +66,10 @@ def locate_function(module_name: str, function_name: str) -> Callable[[], Iterab
def locate_qualified_function(qualified_name: str) -> Callable[[], Iterable[ET]]:
"""
As an example, 'my.reddit.comments' -> locate_function('my.reddit', 'comments')
As an example, 'my.reddit.rexport.comments' -> locate_function('my.reddit.rexport', 'comments')
"""
if "." not in qualified_name:
raise QueryException("Could not find a '.' in the function name, e.g. my.reddit.comments")
raise QueryException("Could not find a '.' in the function name, e.g. my.reddit.rexport.comments")
rdot_index = qualified_name.rindex(".")
return locate_function(qualified_name[:rdot_index], qualified_name[rdot_index + 1:])