Autoextract documentation for some modules, improve docs
This commit is contained in:
parent
9cb39103c6
commit
976b3da6f4
4 changed files with 88 additions and 36 deletions
|
@ -1,15 +1,18 @@
|
|||
'''
|
||||
Module for locating and accessing [[https://takeout.google.com][Google Takeout]] data
|
||||
'''
|
||||
|
||||
from dataclasses import dataclass
|
||||
from ...core.common import Paths
|
||||
|
||||
from my.config import google as user_config
|
||||
@dataclass
|
||||
class google(user_config):
|
||||
'''
|
||||
Expects [[https://takeout.google.com][Google Takeout]] data.
|
||||
'''
|
||||
takeout_path: Paths # path/paths/glob for the takeout zips
|
||||
###
|
||||
|
||||
# TODO rename 'google' to 'takeout'? not sure
|
||||
|
||||
from ...core.cfg import make_config
|
||||
config = make_config(google)
|
||||
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
"""
|
||||
Reddit data: saved items/comments/upvotes/etc.
|
||||
|
||||
Uses [[https://github.com/karlicoss/rexport][rexport]] output.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
@ -11,9 +13,6 @@ from dataclasses import dataclass
|
|||
|
||||
@dataclass
|
||||
class reddit(uconfig):
|
||||
'''
|
||||
Reddit module uses [[https://github.com/karlicoss/rexport][rexport]] output
|
||||
'''
|
||||
export_path: Paths # path[s]/glob to the exported data
|
||||
rexport : Optional[PathIsh] = None # path to a local clone of rexport
|
||||
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
"""
|
||||
Twitter data (tweets and favorites).
|
||||
|
||||
Uses [[https://github.com/twintproject/twint][Twint]] data export.
|
||||
"""
|
||||
|
||||
from ..core.common import Paths
|
||||
|
@ -8,10 +10,7 @@ from my.config import twint as user_config
|
|||
|
||||
@dataclass
|
||||
class twint(user_config):
|
||||
'''
|
||||
Uses [[https://github.com/twintproject/twint][Twint]] data export.
|
||||
'''
|
||||
export_path: Paths # path[s]/glob to twint Sqlite database
|
||||
export_path: Paths # path[s]/glob to the twint Sqlite database
|
||||
|
||||
|
||||
from ..core.cfg import make_config
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue