shoop package¶
Subpackages¶
- shoop.addons package
- shoop.admin package
- Subpackages
- shoop.admin.dashboard package
- shoop.admin.forms package
- shoop.admin.modules package
- Subpackages
- shoop.admin.modules.attributes package
- shoop.admin.modules.categories package
- shoop.admin.modules.contact_groups package
- shoop.admin.modules.contacts package
- shoop.admin.modules.demo package
- shoop.admin.modules.manufacturers package
- shoop.admin.modules.media package
- shoop.admin.modules.orders package
- Subpackages
- shoop.admin.modules.orders.views package
- Submodules
- shoop.admin.modules.orders.views.detail module
- shoop.admin.modules.orders.views.edit module
- shoop.admin.modules.orders.views.list module
- shoop.admin.modules.orders.views.log module
- shoop.admin.modules.orders.views.payment module
- shoop.admin.modules.orders.views.refund module
- shoop.admin.modules.orders.views.shipment module
- Module contents
- shoop.admin.modules.orders.views package
- Submodules
- shoop.admin.modules.orders.dashboard module
- shoop.admin.modules.orders.json_order_creator module
- shoop.admin.modules.orders.receivers module
- shoop.admin.modules.orders.sections module
- Module contents
- Subpackages
- shoop.admin.modules.permission_groups package
- shoop.admin.modules.product_types package
- shoop.admin.modules.products package
- Subpackages
- shoop.admin.modules.products.forms package
- Submodules
- shoop.admin.modules.products.forms.base_forms module
- shoop.admin.modules.products.forms.package_forms module
- shoop.admin.modules.products.forms.parent_forms module
- shoop.admin.modules.products.forms.simple_variation_forms module
- shoop.admin.modules.products.forms.variable_variation_forms module
- Module contents
- shoop.admin.modules.products.views package
- Submodules
- shoop.admin.modules.products.views.delete module
- shoop.admin.modules.products.views.edit module
- shoop.admin.modules.products.views.edit_cross_sell module
- shoop.admin.modules.products.views.edit_media module
- shoop.admin.modules.products.views.edit_package module
- shoop.admin.modules.products.views.edit_parent module
- shoop.admin.modules.products.views.edit_variation module
- shoop.admin.modules.products.views.list module
- shoop.admin.modules.products.views.toolbars module
- Module contents
- shoop.admin.modules.products.forms package
- Submodules
- shoop.admin.modules.products.utils module
- Module contents
- Subpackages
- shoop.admin.modules.sales_units package
- shoop.admin.modules.service_providers package
- shoop.admin.modules.services package
- shoop.admin.modules.shops package
- shoop.admin.modules.suppliers package
- shoop.admin.modules.system package
- shoop.admin.modules.taxes package
- shoop.admin.modules.users package
- Module contents
- Subpackages
- shoop.admin.template_helpers package
- shoop.admin.templatetags package
- shoop.admin.utils package
- shoop.admin.views package
- Submodules
- shoop.admin.base module
- shoop.admin.breadcrumbs module
- shoop.admin.currencybound module
- shoop.admin.form_part module
- shoop.admin.menu module
- shoop.admin.module_registry module
- shoop.admin.toolbar module
- shoop.admin.urls module
- Module contents
- Subpackages
- shoop.api package
- shoop.apps package
- shoop.campaigns package
- Subpackages
- shoop.campaigns.admin_module package
- shoop.campaigns.models package
- Submodules
- shoop.campaigns.models.basket_conditions module
- shoop.campaigns.models.basket_effects module
- shoop.campaigns.models.basket_line_effects module
- shoop.campaigns.models.campaigns module
- shoop.campaigns.models.catalog_filters module
- shoop.campaigns.models.contact_group_sales_ranges module
- shoop.campaigns.models.context_conditions module
- shoop.campaigns.models.product_effects module
- Module contents
- shoop.campaigns.templates package
- Submodules
- shoop.campaigns.apps module
- shoop.campaigns.modules module
- shoop.campaigns.signal_handlers module
- shoop.campaigns.utils module
- Module contents
- Subpackages
- shoop.core package
- Subpackages
- shoop.core.api package
- shoop.core.cache package
- shoop.core.defaults package
- shoop.core.fields package
- shoop.core.management package
- Subpackages
- shoop.core.management.commands package
- Submodules
- shoop.core.management.commands.compute_bought_with_relations module
- shoop.core.management.commands.makemessages module
- shoop.core.management.commands.shoop_init module
- shoop.core.management.commands.shoop_makemessages module
- shoop.core.management.commands.shoop_show_settings module
- Module contents
- shoop.core.management.commands package
- Module contents
- Subpackages
- shoop.core.models package
- shoop.core.modules package
- shoop.core.order_creator package
- shoop.core.pricing package
- shoop.core.shortcuts package
- shoop.core.stocks package
- shoop.core.suppliers package
- shoop.core.taxing package
- shoop.core.templatetags package
- shoop.core.utils package
- Submodules
- shoop.core.utils.form_mixins module
- shoop.core.utils.maintenance module
- shoop.core.utils.model_caching_descriptor module
- shoop.core.utils.name_mixin module
- shoop.core.utils.price_display module
- shoop.core.utils.prices module
- shoop.core.utils.product_bought_with_relations module
- shoop.core.utils.product_caching_object module
- shoop.core.utils.query module
- shoop.core.utils.slugs module
- shoop.core.utils.tax_numbers module
- shoop.core.utils.users module
- shoop.core.utils.vat module
- Module contents
- Submodules
- shoop.core.excs module
- shoop.core.middleware module
- shoop.core.settings module
- shoop.core.signals module
- shoop.core.telemetry module
- Module contents
- Subpackages
- shoop.customer_group_pricing package
- shoop.default_tax package
- shoop.front package
- Subpackages
- shoop.front.admin_module package
- shoop.front.apps package
- shoop.front.basket package
- shoop.front.checkout package
- shoop.front.models package
- shoop.front.template_helpers package
- shoop.front.templatetags package
- shoop.front.utils package
- shoop.front.views package
- Submodules
- shoop.front.error_handling module
- shoop.front.middleware module
- shoop.front.notify_events module
- shoop.front.settings module
- shoop.front.signals module
- shoop.front.urls module
- Module contents
- Subpackages
- shoop.guide package
- shoop.notify package
- Subpackages
- Submodules
- shoop.notify.base module
- shoop.notify.enums module
- shoop.notify.runner module
- shoop.notify.script module
- shoop.notify.settings module
- shoop.notify.template module
- shoop.notify.typology module
- Module contents
- shoop.order_printouts package
- shoop.simple_cms package
- shoop.simple_supplier package
- shoop.testing package
- Subpackages
- Submodules
- shoop.testing.factories module
- shoop.testing.image_generator module
- shoop.testing.mock_population module
- shoop.testing.service_forms module
- shoop.testing.simple_checkout_phase module
- shoop.testing.soup_utils module
- shoop.testing.text_data module
- shoop.testing.utils module
- Module contents
- shoop.themes package
- shoop.utils package
- Submodules
- shoop.utils.analog module
- shoop.utils.dates module
- shoop.utils.decorators module
- shoop.utils.excs module
- shoop.utils.fields module
- shoop.utils.filer module
- shoop.utils.form_group module
- shoop.utils.forms module
- shoop.utils.http module
- shoop.utils.i18n module
- shoop.utils.importing module
- shoop.utils.iterables module
- shoop.utils.models module
- shoop.utils.money module
- shoop.utils.multilanguage_model_form module
- shoop.utils.numbers module
- shoop.utils.objects module
- shoop.utils.patterns module
- shoop.utils.properties module
- shoop.utils.serialization module
- shoop.utils.settings_doc module
- shoop.utils.setup module
- shoop.utils.text module
- shoop.utils.translation module
- Module contents
- shoop.xtheme package
- Subpackages
- shoop.xtheme.admin_module package
- shoop.xtheme.plugins package
- Submodules
- shoop.xtheme.plugins.category_links module
- shoop.xtheme.plugins.consts module
- shoop.xtheme.plugins.forms module
- shoop.xtheme.plugins.image module
- shoop.xtheme.plugins.snippets module
- shoop.xtheme.plugins.social_media_links module
- shoop.xtheme.plugins.text module
- shoop.xtheme.plugins.widgets module
- Module contents
- shoop.xtheme.templatetags package
- shoop.xtheme.views package
- Submodules
- shoop.xtheme.editing module
- shoop.xtheme.engine module
- shoop.xtheme.forms module
- shoop.xtheme.layout module
- shoop.xtheme.models module
- shoop.xtheme.parsing module
- shoop.xtheme.rendering module
- shoop.xtheme.resources module
- shoop.xtheme.template_ns module
- shoop.xtheme.testing module
- shoop.xtheme.urls module
- shoop.xtheme.utils module
- shoop.xtheme.view_config module
- Module contents
- Subpackages
Submodules¶
shoop.configuration module¶
API for Shoop’s Dynamic Configuration.
Idea of the Dynamic Configuration is to allow storing configuration values similarly as Django settings allows, but in a more flexible way: Dynamic Configuration can be changed with a simple API and there is no need restart the application server after changing a value.
Dynamic configuration values are permanent. Current implementation
stores the values with ConfigurationItem model into
database, but that may change in the future.
Configuration values are get and set by a key string. There is a global configuration and a shop specific configuration for each shop. Values in shop specific configuration override the values in global configuration.
-
shoop.configuration.set(shop, key, value)[source]¶ Set configuration item value for a shop or globally.
If given
shopisNone, the value of givenkeyis set globally for all shops. Otherwise sets a shop specific value which overrides the global value in configuration of the specified shop.Parameters: - shop (shoop.core.models.Shop|None) – Shop to set value for, or None to set a global value
- key (str) – Name of the key to set
- value (Any) – Value to set. Note: Must be JSON serializable.
-
shoop.configuration.get(shop, key, default=None)[source]¶ Get configuration value by shop and key.
Global configuration can be accessed with
shop=None.Parameters: - shop (shoop.core.models.Shop|None) – Shop to get configuration value for, or None
- key (str) – Configuration item key
- default (Any) – Default value returned if no value is set for given key (globally or in given shop).
Returns: Configuration value or the default value
Return type: Any