API Reference

The following section outlines the API of Shopi-Py

Shop

class shopipy.Shop(title, currency, footer, description)

Represents a shop. This class is used to store the global configuration of the shop.

A number of options can be passed to the Shop.

Parameters:
  • title (str) - The global title of the store.

  • currency (str) - The global currency used to display the prices of items.

  • description (Optional[str]) - The global description of the store.

  • footer (Optional[str]) - The global footer text for all underlying Pages.

Pages

class shopipy.ShopPage(shop, description, items, footer, on_select, timeout)

Represents a shop page within the Shop. This class is used to configure the individual pages as well as pass the items.

Parameters:

Shop Item

Shop Category

Selectors