Skip to content

generate_order_form #

Functions and classes for generating order forms given order information packaged as a DataFrame extracted using plkit.extract_orders()

Classes:

  • Product –

    Class to hold information about a specific product

Functions:

Product #

Product(name: str)

Class to hold information about a specific product

Parameters#

name : str Name of the particular product

Returns#

None

Methods:

  • update_count –

    Update the product count given a specific sizing

  • update_product –

    Update the product specifications given a specific order

Source code in plkit/generate_order_form.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def __init__(self, name: str) -> None:
    """
    Initialise an empty instance of the product class

    Parameters
    ----------
    name : str
        Name of the particular product

    Returns
    -------
    None
    """

    # Internal dictionary to store the pricing of individual items
    self.pricing = {
        "Unisex EcoLayer Hoodie": 38.40,  # pounds
        "Unisex EcoLayer Hoodie - 1 Personalisation": 42.60,
        "Unisex EcoLayer Hoodie - 2 Personalisations": 46.80,
        "Unisex Shield Performance Sweatshirt": 36.0,
        "Unisex Shield Performance Sweatshirt - 1 Personalisation": 40.20,
        "Unisex Shield Performance Sweatshirt - 2 Personalisations": 44.40,
        "Men's EcoLayer Tee (Navy)": 18.60,
        "Men's EcoLayer Tee - 1 Personalisation (Navy)": 22.80,
        "Men's EcoLayer Tee - 2 Personalisations (Navy)": 27.0,
        "Men's EcoLayer Tee (Forest)": 18.60,
        "Men's EcoLayer Tee - 1 Personalisation (Forest)": 22.80,
        "Men's EcoLayer Tee - 2 Personalisations (Forest)": 27.0,
        "Women's EcoLayer Tee (Navy)": 18.60,
        "Women's EcoLayer Tee - 1 Personalisation (Navy)": 22.80,
        "Women's EcoLayer Tee - 2 Personalisations (Navy)": 27.0,
        "Women's EcoLayer Tee (Forest)": 18.60,
        "Women's EcoLayer Tee - 1 Personalisation (Forest)": 22.80,
        "Women's EcoLayer Tee - 2 Personalisations (Forest)": 27.0,
        "Men's Sublimated Tee (Navy)": 25.62,
        "Men's Sublimated Tee - 1 Personalisation (Navy)": 25.62,
        "Men's Sublimated Tee - 2 Personalisations (Navy)": 25.62,
        "Men's Sublimated Tee (Forest)": 25.62,
        "Men's Sublimated Tee - 1 Personalisation (Forest)": 25.62,
        "Men's Sublimated Tee - 2 Personalisations (Forest)": 25.62,
        "Women's Sublimated Tee (Navy)": 25.62,
        "Women's Sublimated Tee - 1 Personalisation (Navy)": 25.62,
        "Women's Sublimated Tee - 2 Personalisations (Navy)": 25.62,
        "Women's Sublimated Tee (Forest)": 25.62,
        "Women's Sublimated Tee - 1 Personalisation (Forest)": 25.62,
        "Women's Sublimated Tee - 2 Personalisations (Forest)": 25.62
    }

    if name not in self.pricing:
        raise LookupError(f"Item {name} not found.")

    self.name = name
    self.colour = "Forest" if "Forest" in self.name else "Navy"
    self.sizings = {
        "XS": 0,
        "S": 0,
        "M": 0,
        "L": 0,
        "XL": 0,
        "2XL": 0,
        "3XL": 0,
        "4XL": 0,
        "5XL": 0,
    }
    self.total_quantity = 0
    self.unit_price = self.pricing[name]
    self.total_price = 0

update_count #

update_count(sizing, quantity=1) -> None

Update the product count given a specific sizing

Parameters#

sizing : str Sizing for which to update the count quantity : int, optional Item count to update

Returns#

None

Source code in plkit/generate_order_form.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def update_count(self, sizing, quantity=1) -> None:
    """
    Update the product count given a specific sizing

    Parameters
    ----------
    sizing : str
        Sizing for which to update the count
    quantity : int, optional
        Item count to update

    Returns
    -------
    None
    """
    if sizing not in self.sizings:
        raise LookupError(
            f"""Sizing {sizing} not found,
            select a sizing from {list(self.sizings.keys())}"""
        )

    self.sizings[sizing] += quantity
    self.total_quantity += quantity
    self.total_price = self.unit_price * self.total_quantity

update_product #

update_product(order) -> None

Update the product specifications given a specific order

Parameters#

order : class Instance of the Order class which is used to update the product information

Returns#

None

Source code in plkit/generate_order_form.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def update_product(self, order) -> None:
    """
    Update the product specifications given a specific order

    Parameters
    ----------
    order : class
        Instance of the Order class which is used to update the product information

    Returns
    -------
    None
    """

    # Update product names
    order.identify_products()

    # Loop over every item stored in order and update where appropriate
    for n in range(len(order.items)):
        product_name = order.products[n]
        sizing = order.sizings[n]

        # Check for valid product name and sizing
        if isinstance(product_name, str) and product_name.strip() == self.name:
            if isinstance(sizing, str) and sizing.strip() in self.sizings:
                self.update_count(sizing.strip())

generate_product_order #

generate_product_order(df_orders: DataFrame) -> DataFrame

Generate a DataFrame of product-specific order information, given a DataFrame of orders

Parameters#

df_orders: _pd.DataFrame The order details converted to a pandas DataFrame

Returns#

df_products: _pd.DataFrame Full order details for every product, completed with the orders contained in df_orders

Source code in plkit/generate_order_form.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
def generate_product_order(df_orders: _pd.DataFrame) -> _pd.DataFrame:
    """
    Generate a DataFrame of product-specific order information,
    given a DataFrame of orders

    Parameters
    ----------
    df_orders: _pd.DataFrame
        The order details converted to a pandas DataFrame

    Returns
    -------
    df_products: _pd.DataFrame
        Full order details for every product,
        completed with the orders contained in df_orders
    """

    # List of all products - women's sizing is different
    items = [
        "Unisex EcoLayer Hoodie",
        "Unisex EcoLayer Hoodie - 1 Personalisation",
        "Unisex EcoLayer Hoodie - 2 Personalisations",
        "Unisex Shield Performance Sweatshirt",
        "Unisex Shield Performance Sweatshirt - 1 Personalisation",
        "Unisex Shield Performance Sweatshirt - 2 Personalisations",
        "Men's EcoLayer Tee (Navy)",
        "Men's EcoLayer Tee - 1 Personalisation (Navy)",
        "Men's EcoLayer Tee - 2 Personalisations (Navy)",
        "Men's EcoLayer Tee (Forest)",
        "Men's EcoLayer Tee - 1 Personalisation (Forest)",
        "Men's EcoLayer Tee - 2 Personalisations (Forest)",
        "Women's EcoLayer Tee (Navy)",
        "Women's EcoLayer Tee - 1 Personalisation (Navy)",
        "Women's EcoLayer Tee - 2 Personalisations (Navy)",
        "Women's EcoLayer Tee (Forest)",
        "Women's EcoLayer Tee - 1 Personalisation (Forest)",
        "Women's EcoLayer Tee - 2 Personalisations (Forest)",
        "Men's Sublimated Tee (Navy)",
        "Men's Sublimated Tee - 1 Personalisation (Navy)",
        "Men's Sublimated Tee - 2 Personalisations (Navy)",
        "Men's Sublimated Tee (Forest)",
        "Men's Sublimated Tee - 1 Personalisation (Forest)",
        "Men's Sublimated Tee - 2 Personalisations (Forest)",
        "Women's Sublimated Tee (Navy)",
        "Women's Sublimated Tee - 1 Personalisation (Navy)",
        "Women's Sublimated Tee - 2 Personalisations (Navy)",
        "Women's Sublimated Tee (Forest)",
        "Women's Sublimated Tee - 1 Personalisation (Forest)",
        "Women's Sublimated Tee - 2 Personalisations (Forest)"
    ]

    # Names of all people who submitted an order
    names = df_orders["Name"].to_list()

    # Empty df to store product order info
    columns = [
        "Product Name",
        "Colour",
        "Total Quantity",
        "XS",
        "S",
        "M",
        "L",
        "XL",
        "2XL",
        "3XL",
        "4XL",
        "5XL",
        6,
        8,
        10,
        12,
        14,
        16,
        18,
        20,
        22,
        "Unit Price (£)",
        "Total Price (£)",
    ]
    df_products = _pd.DataFrame(columns=columns)

    for item in items:
        product = Product(item)  # Initialise empty class

        for name in names:  # Populate product with the info from all orders
            order = read_order(df_orders, name)
            order.identify_products()
            product.update_product(order)

        df_products = _update_df_products(df_products, product)

    # Add total pricing row
    count_all_items = _np.sum(df_products["Total Quantity"].to_numpy())
    total_price = _np.sum(df_products["Total Price (£)"].to_numpy())

    new_row = [_np.nan] * len(columns)
    new_row[2] = count_all_items
    new_row[-1] = total_price
    df_products.loc[len(df_products)] = new_row
    df_products.iloc[-1, -2] = "Total"  # Add label for total

    # Add label for club name
    new_row = [_np.nan] * len(columns)
    df_products.loc[len(df_products)] = new_row
    df_products.iloc[-1, 1] = "Club Name"
    df_products.iloc[-1, 2] = "Badminton"

    return df_products

generate_product_personalisations #

generate_product_personalisations(
    df_orders: DataFrame,
) -> DataFrame

Generate a DataFrame of product-specific order personalisations, given a DataFrame of orders

Parameters#

df_orders: _pd.DataFrame The order details converted to a pandas DataFrame

Returns#

df_personal: _pd.DataFrame Full personalisation details for every product, completed with the orders contained in df_orders

Source code in plkit/generate_order_form.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
def generate_product_personalisations(df_orders: _pd.DataFrame) -> _pd.DataFrame:
    """
    Generate a DataFrame of product-specific order personalisations,
    given a DataFrame of orders

    Parameters
    ----------
    df_orders: _pd.DataFrame
        The order details converted to a pandas DataFrame

    Returns
    -------
    df_personal: _pd.DataFrame
        Full personalisation details for every product,
        completed with the orders contained in df_orders
    """

    womens_sizing = {
        "XS": 6,
        "S": 8,
        "M": 10,
        "L": 12,
        "XL": 14,
        "2XL": 16,
        "3XL": 18,
        "4XL": 20,
        "5XL": 22,
    }

    # Names of all people who submitted an order
    names = df_orders["Name"].to_list()

    # Empty df to store product order info
    columns = [
        "Product Name",
        "Size",
        "Colour",
        "Initials (sleeve personalisation)",
        "Name (back personalisation)",
    ]

    df_personal = _pd.DataFrame(columns=columns)

    for name in names:  # Populate product with the info from all orders
        order = read_order(df_orders, name)
        order.identify_products()

        for n in range(len(order.items)):
            product_name = order.products[n]

            if isinstance(product_name, str):
                product_name = product_name.strip()
                sizing = order.sizings[n]

                new_row = {
                    "Product Name": product_name,
                    "Size": womens_sizing.get(sizing, sizing)
                    if "Women's" in product_name
                    else sizing,
                    "Colour": "Forest" if "Forest" in product_name else "Navy",
                    "Initials (sleeve personalisation)": order.sleeve_names[n],
                    "Name (back personalisation)": order.back_names[n],
                }

                # Only add column for personalised item
                if isinstance(order.sleeve_names[n], str) or isinstance(
                    order.back_names[n], str
                ):
                    df_personal = _pd.concat(
                        [df_personal, _pd.DataFrame([new_row])], ignore_index=True
                    )

    return df_personal