diff --git a/archivebox/core/settings.py b/archivebox/core/settings.py index b055096b..dff6baa7 100644 --- a/archivebox/core/settings.py +++ b/archivebox/core/settings.py @@ -36,17 +36,17 @@ assert ARCHIVE_DIR == CONFIG.ARCHIVE_DIR def find_plugins_in_dir(plugins_dir: Path, prefix: str) -> Dict[str, Path]: - """{"pkg_plugins.pip": "/app/archivebox/pkg_plugins/pip", "user_plugins.other": "/data/user_plugins/other",...}""" + """{"plugins_pkg.pip": "/app/archivebox/plugins_pkg/pip", "user_plugins.other": "/data/user_plugins/other",...}""" return { f"{prefix}.{plugin_entrypoint.parent.name}": plugin_entrypoint.parent for plugin_entrypoint in sorted(plugins_dir.glob("*/apps.py")) # key=get_plugin_order # Someday enforcing plugin import order may be required, but right now it's not needed } PLUGIN_DIRS = { - 'sys_plugins': PACKAGE_DIR / 'sys_plugins', - 'pkg_plugins': PACKAGE_DIR / 'pkg_plugins', - 'auth_plugins': PACKAGE_DIR / 'auth_plugins', - 'extractor_plugins': PACKAGE_DIR / 'extractor_plugins', + 'plugins_sys': PACKAGE_DIR / 'plugins_sys', + 'plugins_pkg': PACKAGE_DIR / 'plugins_pkg', + 'plugins_auth': PACKAGE_DIR / 'plugins_auth', + 'plugins_extractor': PACKAGE_DIR / 'plugins_extractor', 'user_plugins': DATA_DIR / 'user_plugins', } INSTALLED_PLUGINS = {} @@ -144,7 +144,7 @@ AUTHENTICATION_BACKENDS = [ 'django.contrib.auth.backends.ModelBackend', ] -from ..auth_plugins.ldap.settings import LDAP_CONFIG +from ..plugins_auth.ldap.settings import LDAP_CONFIG if LDAP_CONFIG.LDAP_ENABLED: AUTH_LDAP_BIND_DN = LDAP_CONFIG.LDAP_BIND_DN @@ -559,7 +559,7 @@ LOGGING = { "handlers": ["default", "logfile"], "level": "DEBUG", }, - "extractor_plugins": { + "plugins_extractor": { "handlers": ["default", "logfile"], "level": "DEBUG", }, diff --git a/archivebox/plugantic/base_admindataview.py b/archivebox/plugantic/base_admindataview.py index b5cac1de..72bb4df3 100644 --- a/archivebox/plugantic/base_admindataview.py +++ b/archivebox/plugantic/base_admindataview.py @@ -11,11 +11,11 @@ class BaseAdminDataView(BaseHook): # verbose_name: str = 'Data View' # route: str = '/npm/installed/' - # view: str = 'pkg_plugins.npm.admin.installed_list_view' + # view: str = 'plugins_pkg.npm.admin.installed_list_view' # items: Dict[str, str] = { # "name": "installed_npm_pkg", # 'route': '/', - # 'view': 'pkg_plugins.npm.admin.installed_detail_view', + # 'view': 'plugins_pkg.npm.admin.installed_detail_view', # } def register(self, settings, parent_plugin=None): diff --git a/archivebox/plugantic/base_hook.py b/archivebox/plugantic/base_hook.py index a1339919..17ad0703 100644 --- a/archivebox/plugantic/base_hook.py +++ b/archivebox/plugantic/base_hook.py @@ -26,11 +26,11 @@ class BaseHook(BaseModel): # django imports AppConfig, models, migrations, admins, etc. for all installed apps # django then calls AppConfig.ready() on each installed app... - pkg_plugins.npm.NpmPlugin().AppConfig.ready() # called by django - pkg_plugins.npm.NpmPlugin().register(settings) -> - pkg_plugins.npm.NpmConfigSet().register(settings) + plugins_pkg.npm.NpmPlugin().AppConfig.ready() # called by django + plugins_pkg.npm.NpmPlugin().register(settings) -> + plugins_pkg.npm.NpmConfigSet().register(settings) plugantic.base_configset.BaseConfigSet().register(settings) - plugantic.base_hook.BaseHook().register(settings, parent_plugin=pkg_plugins.npm.NpmPlugin()) + plugantic.base_hook.BaseHook().register(settings, parent_plugin=plugins_pkg.npm.NpmPlugin()) ... ... @@ -74,17 +74,17 @@ class BaseHook(BaseModel): @property def hook_module(self) -> str: - """e.g. extractor_plugins.singlefile.apps.SinglefileConfigSet""" + """e.g. plugins_extractor.singlefile.apps.SinglefileConfigSet""" return f'{self.__module__}.{self.__class__.__name__}' @property def hook_file(self) -> Path: - """e.g. extractor_plugins.singlefile.apps.SinglefileConfigSet""" + """e.g. plugins_extractor.singlefile.apps.SinglefileConfigSet""" return Path(inspect.getfile(self.__class__)) @property def plugin_module(self) -> str: - """e.g. extractor_plugins.singlefile""" + """e.g. plugins_extractor.singlefile""" return f"{self.__module__}.{self.__class__.__name__}".split("archivebox.", 1)[-1].rsplit(".apps.", 1)[0] @property diff --git a/archivebox/plugantic/base_plugin.py b/archivebox/plugantic/base_plugin.py index 8e44ee61..2bad938d 100644 --- a/archivebox/plugantic/base_plugin.py +++ b/archivebox/plugantic/base_plugin.py @@ -61,14 +61,14 @@ class BasePlugin(BaseModel): def plugin_module(self) -> str: # DottedImportPath """ " Dotted import path of the plugin's module (after its loaded via settings.INSTALLED_APPS). - e.g. 'archivebox.pkg_plugins.npm.apps.NpmPlugin' -> 'pkg_plugins.npm' + e.g. 'archivebox.plugins_pkg.npm.apps.NpmPlugin' -> 'plugins_pkg.npm' """ return f"{self.__module__}.{self.__class__.__name__}".split("archivebox.", 1)[-1].rsplit('.apps.', 1)[0] @property def plugin_module_full(self) -> str: # DottedImportPath - """e.g. 'archivebox.pkg_plugins.npm.apps.NpmPlugin'""" + """e.g. 'archivebox.plugins_pkg.npm.apps.NpmPlugin'""" return f"{self.__module__}.{self.__class__.__name__}" # @computed_field @@ -84,7 +84,7 @@ class BasePlugin(BaseModel): # preserve references to original default objects, # pydantic deepcopies them by default which breaks mutability # see https://github.com/pydantic/pydantic/issues/7608 - # if we dont do this, then sys_plugins.base.CORE_CONFIG != settings.CONFIGS.CoreConfig for example + # if we dont do this, then plugins_sys.base.CORE_CONFIG != settings.CONFIGS.CoreConfig for example # and calling .__init__() on one of them will not update the other self.hooks = self.model_fields['hooks'].default diff --git a/archivebox/auth_plugins/ldap/__init__.py b/archivebox/plugins_auth/ldap/__init__.py similarity index 100% rename from archivebox/auth_plugins/ldap/__init__.py rename to archivebox/plugins_auth/ldap/__init__.py diff --git a/archivebox/auth_plugins/ldap/apps.py b/archivebox/plugins_auth/ldap/apps.py similarity index 93% rename from archivebox/auth_plugins/ldap/apps.py rename to archivebox/plugins_auth/ldap/apps.py index 5cf18fec..f7fd2ef7 100644 --- a/archivebox/auth_plugins/ldap/apps.py +++ b/archivebox/plugins_auth/ldap/apps.py @@ -1,4 +1,4 @@ -__package__ = 'archivebox.auth_plugins.ldap' +__package__ = 'archivebox.plugins_auth.ldap' import inspect @@ -14,7 +14,7 @@ from plugantic.base_plugin import BasePlugin from plugantic.base_hook import BaseHook from plugantic.base_binary import BaseBinary, BaseBinProvider -from pkg_plugins.pip.apps import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER +from plugins_pkg.pip.apps import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER from .settings import LDAP_CONFIG, LDAP_LIB diff --git a/archivebox/auth_plugins/ldap/settings.py b/archivebox/plugins_auth/ldap/settings.py similarity index 98% rename from archivebox/auth_plugins/ldap/settings.py rename to archivebox/plugins_auth/ldap/settings.py index f7320ee0..f9eb7a3c 100644 --- a/archivebox/auth_plugins/ldap/settings.py +++ b/archivebox/plugins_auth/ldap/settings.py @@ -1,4 +1,4 @@ -__package__ = 'archivebox.auth_plugins.ldap' +__package__ = 'archivebox.plugins_auth.ldap' import sys diff --git a/archivebox/extractor_plugins/__init__.py b/archivebox/plugins_extractor/__init__.py similarity index 100% rename from archivebox/extractor_plugins/__init__.py rename to archivebox/plugins_extractor/__init__.py diff --git a/archivebox/extractor_plugins/chrome/__init__.py b/archivebox/plugins_extractor/chrome/__init__.py similarity index 100% rename from archivebox/extractor_plugins/chrome/__init__.py rename to archivebox/plugins_extractor/chrome/__init__.py diff --git a/archivebox/extractor_plugins/chrome/apps.py b/archivebox/plugins_extractor/chrome/apps.py similarity index 97% rename from archivebox/extractor_plugins/chrome/apps.py rename to archivebox/plugins_extractor/chrome/apps.py index 7f197e26..5c9a71b5 100644 --- a/archivebox/extractor_plugins/chrome/apps.py +++ b/archivebox/plugins_extractor/chrome/apps.py @@ -23,8 +23,8 @@ from plugantic.base_binary import BaseBinary, env from plugantic.base_hook import BaseHook # Depends on Other Plugins: -from pkg_plugins.puppeteer.apps import PUPPETEER_BINPROVIDER -from pkg_plugins.playwright.apps import PLAYWRIGHT_BINPROVIDER +from plugins_pkg.puppeteer.apps import PUPPETEER_BINPROVIDER +from plugins_pkg.playwright.apps import PLAYWRIGHT_BINPROVIDER CHROMIUM_BINARY_NAMES_LINUX = [ diff --git a/archivebox/extractor_plugins/singlefile/__init__.py b/archivebox/plugins_extractor/singlefile/__init__.py similarity index 100% rename from archivebox/extractor_plugins/singlefile/__init__.py rename to archivebox/plugins_extractor/singlefile/__init__.py diff --git a/archivebox/extractor_plugins/singlefile/apps.py b/archivebox/plugins_extractor/singlefile/apps.py similarity index 96% rename from archivebox/extractor_plugins/singlefile/apps.py rename to archivebox/plugins_extractor/singlefile/apps.py index e5386969..d8526e9a 100644 --- a/archivebox/extractor_plugins/singlefile/apps.py +++ b/archivebox/plugins_extractor/singlefile/apps.py @@ -1,4 +1,4 @@ -__package__ = 'archivebox.extractor_plugins.singlefile' +__package__ = 'archivebox.plugins_extractor.singlefile' from pathlib import Path from typing import List, Dict, Optional, ClassVar @@ -19,8 +19,8 @@ from plugantic.base_queue import BaseQueue from plugantic.base_hook import BaseHook # Depends on Other Plugins: -from sys_plugins.base.apps import ARCHIVING_CONFIG -from pkg_plugins.npm.apps import SYS_NPM_BINPROVIDER, LIB_NPM_BINPROVIDER +from plugins_sys.base.apps import ARCHIVING_CONFIG +from plugins_pkg.npm.apps import SYS_NPM_BINPROVIDER, LIB_NPM_BINPROVIDER ###################### Config ########################## diff --git a/archivebox/extractor_plugins/singlefile/migrations/0001_initial.py b/archivebox/plugins_extractor/singlefile/migrations/0001_initial.py similarity index 100% rename from archivebox/extractor_plugins/singlefile/migrations/0001_initial.py rename to archivebox/plugins_extractor/singlefile/migrations/0001_initial.py diff --git a/archivebox/extractor_plugins/singlefile/migrations/__init__.py b/archivebox/plugins_extractor/singlefile/migrations/__init__.py similarity index 100% rename from archivebox/extractor_plugins/singlefile/migrations/__init__.py rename to archivebox/plugins_extractor/singlefile/migrations/__init__.py diff --git a/archivebox/extractor_plugins/singlefile/models.py b/archivebox/plugins_extractor/singlefile/models.py similarity index 100% rename from archivebox/extractor_plugins/singlefile/models.py rename to archivebox/plugins_extractor/singlefile/models.py diff --git a/archivebox/extractor_plugins/singlefile/tasks.py b/archivebox/plugins_extractor/singlefile/tasks.py similarity index 100% rename from archivebox/extractor_plugins/singlefile/tasks.py rename to archivebox/plugins_extractor/singlefile/tasks.py diff --git a/archivebox/extractor_plugins/ytdlp/__init__.py b/archivebox/plugins_extractor/ytdlp/__init__.py similarity index 100% rename from archivebox/extractor_plugins/ytdlp/__init__.py rename to archivebox/plugins_extractor/ytdlp/__init__.py diff --git a/archivebox/extractor_plugins/ytdlp/apps.py b/archivebox/plugins_extractor/ytdlp/apps.py similarity index 98% rename from archivebox/extractor_plugins/ytdlp/apps.py rename to archivebox/plugins_extractor/ytdlp/apps.py index a513119c..2897a97a 100644 --- a/archivebox/extractor_plugins/ytdlp/apps.py +++ b/archivebox/plugins_extractor/ytdlp/apps.py @@ -10,7 +10,7 @@ from plugantic.base_configset import BaseConfigSet, ConfigSectionName from plugantic.base_binary import BaseBinary, env, apt, brew from plugantic.base_hook import BaseHook -from pkg_plugins.pip.apps import pip +from plugins_pkg.pip.apps import pip ###################### Config ########################## diff --git a/archivebox/pkg_plugins/npm/__init__.py b/archivebox/plugins_pkg/npm/__init__.py similarity index 100% rename from archivebox/pkg_plugins/npm/__init__.py rename to archivebox/plugins_pkg/npm/__init__.py diff --git a/archivebox/pkg_plugins/npm/apps.py b/archivebox/plugins_pkg/npm/apps.py similarity index 97% rename from archivebox/pkg_plugins/npm/apps.py rename to archivebox/plugins_pkg/npm/apps.py index 96585ba2..51eb1214 100644 --- a/archivebox/pkg_plugins/npm/apps.py +++ b/archivebox/plugins_pkg/npm/apps.py @@ -1,4 +1,4 @@ -__package__ = 'archivebox.pkg_plugins.npm' +__package__ = 'archivebox.plugins_pkg.npm' from pathlib import Path from typing import List, Optional diff --git a/archivebox/pkg_plugins/pip/__init__.py b/archivebox/plugins_pkg/pip/__init__.py similarity index 100% rename from archivebox/pkg_plugins/pip/__init__.py rename to archivebox/plugins_pkg/pip/__init__.py diff --git a/archivebox/pkg_plugins/pip/apps.py b/archivebox/plugins_pkg/pip/apps.py similarity index 100% rename from archivebox/pkg_plugins/pip/apps.py rename to archivebox/plugins_pkg/pip/apps.py diff --git a/archivebox/pkg_plugins/playwright/__init__.py b/archivebox/plugins_pkg/playwright/__init__.py similarity index 100% rename from archivebox/pkg_plugins/playwright/__init__.py rename to archivebox/plugins_pkg/playwright/__init__.py diff --git a/archivebox/pkg_plugins/playwright/apps.py b/archivebox/plugins_pkg/playwright/apps.py similarity index 99% rename from archivebox/pkg_plugins/playwright/apps.py rename to archivebox/plugins_pkg/playwright/apps.py index cd606884..830e4139 100644 --- a/archivebox/pkg_plugins/playwright/apps.py +++ b/archivebox/plugins_pkg/playwright/apps.py @@ -27,7 +27,7 @@ from plugantic.base_binary import BaseBinary, BaseBinProvider, env # from plugantic.base_queue import BaseQueue from plugantic.base_hook import BaseHook -from pkg_plugins.pip.apps import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER, LIB_PIP_BINPROVIDER +from plugins_pkg.pip.apps import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER, LIB_PIP_BINPROVIDER ###################### Config ########################## diff --git a/archivebox/pkg_plugins/puppeteer/__init__.py b/archivebox/plugins_pkg/puppeteer/__init__.py similarity index 100% rename from archivebox/pkg_plugins/puppeteer/__init__.py rename to archivebox/plugins_pkg/puppeteer/__init__.py diff --git a/archivebox/pkg_plugins/puppeteer/apps.py b/archivebox/plugins_pkg/puppeteer/apps.py similarity index 99% rename from archivebox/pkg_plugins/puppeteer/apps.py rename to archivebox/plugins_pkg/puppeteer/apps.py index a6bf67da..c6faf324 100644 --- a/archivebox/pkg_plugins/puppeteer/apps.py +++ b/archivebox/plugins_pkg/puppeteer/apps.py @@ -25,7 +25,7 @@ from plugantic.base_binary import BaseBinary, BaseBinProvider, env from plugantic.base_hook import BaseHook # Depends on Other Plugins: -from pkg_plugins.npm.apps import LIB_NPM_BINPROVIDER, SYS_NPM_BINPROVIDER +from plugins_pkg.npm.apps import LIB_NPM_BINPROVIDER, SYS_NPM_BINPROVIDER ###################### Config ########################## diff --git a/archivebox/sys_plugins/base/__init__.py b/archivebox/plugins_sys/base/__init__.py similarity index 100% rename from archivebox/sys_plugins/base/__init__.py rename to archivebox/plugins_sys/base/__init__.py diff --git a/archivebox/sys_plugins/base/apps.py b/archivebox/plugins_sys/base/apps.py similarity index 100% rename from archivebox/sys_plugins/base/apps.py rename to archivebox/plugins_sys/base/apps.py