shuup package¶
Subpackages¶
- shuup.addons package
- shuup.admin package
- Subpackages
- shuup.admin.breadcrumbs package
- shuup.admin.dashboard package
- shuup.admin.forms package
- shuup.admin.modules package
- Subpackages
- shuup.admin.modules.attributes package
- shuup.admin.modules.categories package
- shuup.admin.modules.contact_groups package
- shuup.admin.modules.contacts package
- shuup.admin.modules.content package
- shuup.admin.modules.currencies package
- shuup.admin.modules.customers_dashboard package
- shuup.admin.modules.demo package
- shuup.admin.modules.manufacturers package
- shuup.admin.modules.media package
- shuup.admin.modules.orders package
- Subpackages
- shuup.admin.modules.orders.views package
- Submodules
- shuup.admin.modules.orders.views.addresses module
- shuup.admin.modules.orders.views.detail module
- shuup.admin.modules.orders.views.edit module
- shuup.admin.modules.orders.views.list module
- shuup.admin.modules.orders.views.log module
- shuup.admin.modules.orders.views.payment module
- shuup.admin.modules.orders.views.refund module
- shuup.admin.modules.orders.views.shipment module
- shuup.admin.modules.orders.views.status module
- Module contents
- shuup.admin.modules.orders.views package
- Submodules
- shuup.admin.modules.orders.json_order_creator module
- shuup.admin.modules.orders.mass_actions module
- shuup.admin.modules.orders.receivers module
- shuup.admin.modules.orders.sections module
- shuup.admin.modules.orders.toolbar module
- shuup.admin.modules.orders.utils module
- Module contents
- Subpackages
- shuup.admin.modules.permission_groups package
- shuup.admin.modules.product_types package
- shuup.admin.modules.products package
- Subpackages
- shuup.admin.modules.products.forms package
- Submodules
- shuup.admin.modules.products.forms.base_forms module
- shuup.admin.modules.products.forms.package_forms module
- shuup.admin.modules.products.forms.parent_forms module
- shuup.admin.modules.products.forms.simple_variation_forms module
- shuup.admin.modules.products.forms.variable_variation_forms module
- Module contents
- shuup.admin.modules.products.views package
- Submodules
- shuup.admin.modules.products.views.delete module
- shuup.admin.modules.products.views.edit module
- shuup.admin.modules.products.views.edit_cross_sell module
- shuup.admin.modules.products.views.edit_media module
- shuup.admin.modules.products.views.edit_package module
- shuup.admin.modules.products.views.edit_parent module
- shuup.admin.modules.products.views.edit_variation module
- shuup.admin.modules.products.views.list module
- shuup.admin.modules.products.views.mass_edit module
- shuup.admin.modules.products.views.toolbars module
- Module contents
- shuup.admin.modules.products.forms package
- Submodules
- shuup.admin.modules.products.mass_actions module
- shuup.admin.modules.products.sections module
- shuup.admin.modules.products.signal_handlers module
- shuup.admin.modules.products.utils module
- Module contents
- Subpackages
- shuup.admin.modules.sales_dashboard package
- shuup.admin.modules.sales_units package
- shuup.admin.modules.sample_data package
- shuup.admin.modules.service_providers package
- shuup.admin.modules.services package
- shuup.admin.modules.settings package
- Subpackages
- Submodules
- shuup.admin.modules.settings.consts module
- shuup.admin.modules.settings.enums module
- shuup.admin.modules.settings.view_settings module
- Module contents
- shuup.admin.modules.shops package
- shuup.admin.modules.suppliers package
- shuup.admin.modules.support package
- shuup.admin.modules.system package
- shuup.admin.modules.taxes package
- shuup.admin.modules.users package
- Module contents
- Subpackages
- shuup.admin.template_helpers package
- shuup.admin.templatetags package
- shuup.admin.utils package
- Submodules
- shuup.admin.utils.bs3_renderers module
- shuup.admin.utils.forms module
- shuup.admin.utils.permissions module
- shuup.admin.utils.picotable module
- shuup.admin.utils.search module
- shuup.admin.utils.str_utils module
- shuup.admin.utils.tour module
- shuup.admin.utils.urls module
- shuup.admin.utils.views module
- shuup.admin.utils.wizard module
- Module contents
- shuup.admin.views package
- Submodules
- shuup.admin.base module
- shuup.admin.currencybound module
- shuup.admin.error_handlers module
- shuup.admin.form_modifier module
- shuup.admin.form_part module
- shuup.admin.menu module
- shuup.admin.module_registry module
- shuup.admin.settings module
- shuup.admin.signals module
- shuup.admin.toolbar module
- shuup.admin.urls module
- Module contents
- Subpackages
- shuup.api package
- shuup.apps package
- shuup.campaigns package
- Subpackages
- shuup.campaigns.admin_module package
- shuup.campaigns.models package
- Submodules
- shuup.campaigns.models.basket_conditions module
- shuup.campaigns.models.basket_effects module
- shuup.campaigns.models.basket_line_effects module
- shuup.campaigns.models.campaigns module
- shuup.campaigns.models.catalog_filters module
- shuup.campaigns.models.context_conditions module
- shuup.campaigns.models.matching module
- shuup.campaigns.models.product_effects module
- Module contents
- shuup.campaigns.templates package
- shuup.campaigns.utils package
- Submodules
- shuup.campaigns.apps module
- shuup.campaigns.consts module
- shuup.campaigns.modules module
- shuup.campaigns.reports module
- shuup.campaigns.signal_handlers module
- Module contents
- Subpackages
- shuup.core package
- Subpackages
- shuup.core.basket package
- shuup.core.cache package
- shuup.core.defaults package
- shuup.core.fields package
- shuup.core.management package
- Subpackages
- shuup.core.management.commands package
- Submodules
- shuup.core.management.commands.compute_bought_with_relations module
- shuup.core.management.commands.makemessages module
- shuup.core.management.commands.shuup_extract_products_shortdescription module
- shuup.core.management.commands.shuup_init module
- shuup.core.management.commands.shuup_makemessages module
- shuup.core.management.commands.shuup_makemigrations module
- shuup.core.management.commands.shuup_migrate_from_shoop module
- shuup.core.management.commands.shuup_show_settings module
- Module contents
- shuup.core.management.commands package
- Module contents
- Subpackages
- shuup.core.models package
- shuup.core.modules package
- shuup.core.order_creator package
- shuup.core.pricing package
- shuup.core.shortcuts package
- shuup.core.stocks package
- shuup.core.suppliers package
- shuup.core.taxing package
- shuup.core.templatetags package
- shuup.core.utils package
- Submodules
- shuup.core.utils.context_cache module
- shuup.core.utils.db module
- shuup.core.utils.form_mixins module
- shuup.core.utils.formatters module
- shuup.core.utils.forms module
- shuup.core.utils.line_unit_mixin module
- shuup.core.utils.maintenance module
- shuup.core.utils.menu module
- shuup.core.utils.model_caching_descriptor module
- shuup.core.utils.name_mixin module
- shuup.core.utils.price_display module
- shuup.core.utils.prices module
- shuup.core.utils.product_bought_with_relations module
- shuup.core.utils.product_caching_object module
- shuup.core.utils.product_statistics module
- shuup.core.utils.query module
- shuup.core.utils.slugs module
- shuup.core.utils.tax_numbers module
- shuup.core.utils.users module
- shuup.core.utils.vat module
- Module contents
- Submodules
- shuup.core.error_handling module
- shuup.core.excs module
- shuup.core.middleware module
- shuup.core.settings module
- shuup.core.signals module
- shuup.core.telemetry module
- Module contents
- Subpackages
- shuup.default_tax package
- shuup.front package
- Subpackages
- shuup.front.admin_module package
- shuup.front.apps package
- Subpackages
- shuup.front.apps.auth package
- shuup.front.apps.carousel package
- shuup.front.apps.customer_information package
- shuup.front.apps.personal_order_history package
- shuup.front.apps.registration package
- shuup.front.apps.saved_carts package
- shuup.front.apps.simple_order_notification package
- shuup.front.apps.simple_search package
- Module contents
- Subpackages
- shuup.front.basket package
- shuup.front.checkout package
- shuup.front.forms package
- shuup.front.models package
- shuup.front.notify_script_templates package
- shuup.front.template_helpers package
- shuup.front.templatetags package
- shuup.front.themes package
- shuup.front.utils package
- shuup.front.views package
- Submodules
- shuup.front.views.basket module
- shuup.front.views.category module
- shuup.front.views.checkout module
- shuup.front.views.dashboard module
- shuup.front.views.index module
- shuup.front.views.misc module
- shuup.front.views.order module
- shuup.front.views.payment module
- shuup.front.views.product module
- Module contents
- Submodules
- shuup.front.error_handlers module
- shuup.front.middleware module
- shuup.front.notify_events module
- shuup.front.settings module
- shuup.front.signals module
- shuup.front.urls module
- Module contents
- Subpackages
- shuup.guide package
- shuup.importer package
- shuup.notify package
- Subpackages
- Submodules
- shuup.notify.base module
- shuup.notify.enums module
- shuup.notify.runner module
- shuup.notify.script module
- shuup.notify.settings module
- shuup.notify.template module
- shuup.notify.typology module
- Module contents
- shuup.order_printouts package
- shuup.regions package
- shuup.reports package
- shuup.simple_cms package
- shuup.simple_supplier package
- shuup.testing package
- Subpackages
- Submodules
- shuup.testing.browser_utils module
- shuup.testing.checkout_with_login_and_register_urls module
- shuup.testing.extend_classes module
- shuup.testing.factories module
- shuup.testing.image_generator module
- shuup.testing.mock_population module
- shuup.testing.notify_script_templates module
- shuup.testing.service_forms module
- shuup.testing.simple_checkout_phase module
- shuup.testing.single_page_checkout_test_urls module
- shuup.testing.single_page_checkout_with_login_and_register_conf module
- shuup.testing.soup_utils module
- shuup.testing.text_data module
- shuup.testing.utils module
- Module contents
- shuup.themes package
- shuup.utils package
- Submodules
- shuup.utils.analog module
- shuup.utils.babel_precision_provider module
- shuup.utils.dates module
- shuup.utils.decorators module
- shuup.utils.deprecation module
- shuup.utils.djangoenv module
- shuup.utils.excs module
- shuup.utils.fields module
- shuup.utils.filer module
- shuup.utils.form_group module
- shuup.utils.forms module
- shuup.utils.http module
- shuup.utils.i18n module
- shuup.utils.importing module
- shuup.utils.iterables module
- shuup.utils.models module
- shuup.utils.money module
- shuup.utils.multilanguage_model_form module
- shuup.utils.numbers module
- shuup.utils.objects module
- shuup.utils.patterns module
- shuup.utils.pdf module
- shuup.utils.properties module
- shuup.utils.serialization module
- shuup.utils.settings_doc module
- shuup.utils.setup module
- shuup.utils.text module
- shuup.utils.translation module
- Module contents
- shuup.xtheme package
- Subpackages
- shuup.xtheme.admin_module package
- shuup.xtheme.plugins package
- Submodules
- shuup.xtheme.plugins.category_links module
- shuup.xtheme.plugins.consts module
- shuup.xtheme.plugins.forms module
- shuup.xtheme.plugins.image module
- shuup.xtheme.plugins.products module
- shuup.xtheme.plugins.snippets module
- shuup.xtheme.plugins.social_media_links module
- shuup.xtheme.plugins.text module
- shuup.xtheme.plugins.widgets module
- Module contents
- shuup.xtheme.templatetags package
- shuup.xtheme.views package
- Submodules
- shuup.xtheme.editing module
- shuup.xtheme.engine module
- shuup.xtheme.extenders module
- shuup.xtheme.forms module
- shuup.xtheme.layout module
- shuup.xtheme.models module
- shuup.xtheme.parsing module
- shuup.xtheme.rendering module
- shuup.xtheme.resources module
- shuup.xtheme.template_ns module
- shuup.xtheme.testing module
- shuup.xtheme.urls module
- shuup.xtheme.utils module
- shuup.xtheme.view_config module
- Module contents
- Subpackages
Submodules¶
shuup.configuration module¶
API for Shuup’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.
-
shuup.configuration.
set
(shop, key, value)[source]¶ Set configuration item value for a shop or globally.
If given
shop
isNone
, the value of givenkey
is set globally for all shops. Otherwise sets a shop specific value which overrides the global value in configuration of the specified shop.Parameters: - shop (shuup.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.
-
shuup.configuration.
get
(shop, key, default=None)[source]¶ Get configuration value by shop and key.
Global configuration can be accessed with
shop=None
.Parameters: - shop (shuup.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