slixfeed package
Submodules
slixfeed.config module
TODO
Site-specific filter (i.e. audiobookbay).
Exclude sites from being subjected to filtering (e.g. metapedia).
- Filter phrases:
Refer to sqlitehandler.search_entries for implementation. It is expected to be more complex than function search_entries.
Copy file from /etc/slixfeed/ or /usr/share/slixfeed/
- class slixfeed.config.Cache
Bases:
object- get_directory()
Determine the directory path where cache files be stored.
If $XDG_CACHE_HOME is defined, use it;
else if $HOME exists, use it;
else if the platform is Windows, use %APPDATA%;
else use the current directory.
- Returns:
Path to cache directory.
- Return type:
str
- class slixfeed.config.Config
Bases:
object- get_directory()
Determine the directory path where setting files be stored.
If $XDG_CONFIG_HOME is defined, use it;
else if $HOME exists, use it;
else if the platform is Windows, use %APPDATA%;
else use the current directory.
- Returns:
Path to configuration directory.
- Return type:
str
- async set_setting_value(jid_bare, db_file, key, val)
- class slixfeed.config.Data
Bases:
object- get_directory()
Determine the directory path where dbfile will be stored.
If $XDG_DATA_HOME is defined, use it;
else if $HOME exists, use it;
else if the platform is Windows, use %APPDATA%;
else use the current directory.
- Returns:
Path to database file.
- Return type:
str
Note
This function was taken from project buku.
See https://github.com/jarun/buku
Arun Prakash Jana (jarun)
Dmitry Marakasov (AMDmi3)
- class slixfeed.config.Settings
Bases:
object- get_directory()
Determine the directory path where setting files be stored.
If $XDG_CONFIG_HOME is defined, use it;
else if $HOME exists, use it;
else if the platform is Windows, use %APPDATA%;
else use the current directory.
- Returns:
Path to configuration directory.
- Return type:
str
Bases:
objectDetermine the directory path where data files be stored.
If $XDG_DATA_HOME is defined, use it;
else if $HOME exists, use it;
else if the platform is Windows, use %APPDATA%;
else use the current directory.
- Returns:
Path to database file.
- Return type:
str
- slixfeed.config.add_to_list(newwords, keywords)
Append new keywords to list.
- Parameters:
newwords (str) – List of new keywords.
keywords (str) – List of current keywords.
- Returns:
val – List of current keywords and new keywords.
- Return type:
str
- slixfeed.config.clear_values(input)
- slixfeed.config.get_setting_value(db_file, key)
- slixfeed.config.get_values(filename, key=None)
- slixfeed.config.is_include_keyword(db_file, key, string)
Check keyword match.
- Parameters:
db_file (str) – Path to database file.
type (str) – “allow” or “deny”.
string (str) – String.
- Return type:
Matched keyword or None.
- slixfeed.config.remove_from_list(newwords, keywords)
Remove given keywords from list.
- Parameters:
newwords (str) – List of new keywords.
keywords (str) – List of current keywords.
- Returns:
val – List of new keywords.
- Return type:
str