Slide 1

Slide 1 text

Writing a Django e-commerce framework David Winterbottom @codeinthehole

Slide 2

Slide 2 text

Synopsis • Background / challenges • Why django / python • Customising django apps • E-commerce tips

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

Background

Slide 7

Slide 7 text

• 5 years of e-commerce projects • PHP / Python / Django • Lots of war stories

Slide 8

Slide 8 text

Books

Slide 9

Slide 9 text

Bookshop domain • Millions of products • ISBNs, BIC categories, authors, publishers • Automated feed-driven processing • Catalogue • Stock • Rich data

Slide 10

Slide 10 text

Two tier structure • Application tier - serves HTTP requests • Processing tier • Download and import feeds • Data cleaning and processing

Slide 11

Slide 11 text

More books

Slide 12

Slide 12 text

Different... • Fulfilment partners • Stock logic • Payment partners • Multiple payment sources • Complicated offers • eBooks!

Slide 13

Slide 13 text

PHP framework • Customisation via include path overrides • Lots of duplication • Hard to upgrade • Not-invented-here syndrome

Slide 14

Slide 14 text

Nailvarnish

Slide 15

Slide 15 text

T-shirts

Slide 16

Slide 16 text

Digital music

Slide 17

Slide 17 text

Bar equipment

Slide 18

Slide 18 text

New requirements • Product variations - colours, sizes etc • New fulfilment processes • Pricing models

Slide 19

Slide 19 text

B2B • Sales reps • Tax rules • Managed budgets • Integration with “enterprise” software

Slide 20

Slide 20 text

• Original assumptions all broken • Domains vary wildly • Lots of work-arounds

Slide 21

Slide 21 text

No content

Slide 22

Slide 22 text

Requirements • Agnostic - few assumptions as possible • Models domain • without duplication • without too much meta-data

Slide 23

Slide 23 text

EAV ENTITY ATTRIBUTE VALUE Product Weight 150 Order Cost centre ZPAN

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

• Leather gloves

Slide 27

Slide 27 text

Bendy bits

Slide 28

Slide 28 text

Taxonomy

Slide 29

Slide 29 text

Stock

Slide 30

Slide 30 text

Shipping

Slide 31

Slide 31 text

Payment

Slide 32

Slide 32 text

and also...

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

Nothing is sacred

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

django-oscar • Django 1.3 • Experience of last 5 years baked into models • Lean core • Different customisation path

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

Lots of others • Satchmo • Lightning-Fast-Shop • Satchless • Django-shop • Plata, Mamona, Cartridge, ... • http://djangopackages.com/grids/g/ecommerce/

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

Decimals

Slide 42

Slide 42 text

No content

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

No content

Slide 45

Slide 45 text

kwargs

Slide 46

Slide 46 text

Shipping calculator

Slide 47

Slide 47 text

PHP

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

No content

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

No content

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

No content

Slide 54

Slide 54 text

No content

Slide 55

Slide 55 text

Python

Slide 56

Slide 56 text

No content

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

Web framework • Well-thought out structure • Templating, HTTP, caching, ... • Good test support • Security • Class-based views

Slide 59

Slide 59 text

Models • Models drive the design • Capture domain logic • Foundation for rest of application

Slide 60

Slide 60 text

Eco-system • Haystack (search) • South (database migrations) • Celery (job queue) • Internal libraries

Slide 61

Slide 61 text

No content

Slide 62

Slide 62 text

Customisation

Slide 63

Slide 63 text

Techniques

Slide 64

Slide 64 text

DEBUG = True settings.py

Slide 65

Slide 65 text

AUTH_PROFILE_MODULE = ‘customer.Profile’ settings.py

Slide 66

Slide 66 text

Key idea • Having the same name/identifier as your parent • Subclass and override

Slide 67

Slide 67 text

Templates

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

Django looks here first

Slide 73

Slide 73 text

Views

Slide 74

Slide 74 text

Oscar default

Slide 75

Slide 75 text

urls.py

Slide 76

Slide 76 text

oscar/app.py

Slide 77

Slide 77 text

oscar/core/app.py

Slide 78

Slide 78 text

oscar/apps/checkout/app.py

Slide 79

Slide 79 text

Oscar project

Slide 80

Slide 80 text

Replace application urls.py

Slide 81

Slide 81 text

myproject/app.py Use different app instance

Slide 82

Slide 82 text

myproject/checkout/app.py Use different view classes

Slide 83

Slide 83 text

myproject/checkout/views.py Override and extend method

Slide 84

Slide 84 text

Models

Slide 85

Slide 85 text

Oscar default

Slide 86

Slide 86 text

settings.py

Slide 87

Slide 87 text

abstract_models.py

Slide 88

Slide 88 text

models.py

Slide 89

Slide 89 text

Oscar project

Slide 90

Slide 90 text

replaces oscar app settings.py same ‘app label’

Slide 91

Slide 91 text

add custom fields myproject/voucher/models.py import remaining models

Slide 92

Slide 92 text

templatetags management commands fixtures settings.py

Slide 93

Slide 93 text

Classes

Slide 94

Slide 94 text

model name ‘app label’

Slide 95

Slide 95 text

module path class name

Slide 96

Slide 96 text

use same class name as in core

Slide 97

Slide 97 text

Recap • Bit of a work-around... • ...but works well • Applicable to other django libraries

Slide 98

Slide 98 text

Best practices

Slide 99

Slide 99 text

Log everything ...except bankcard details.

Slide 100

Slide 100 text

Audit models

Slide 101

Slide 101 text

No content

Slide 102

Slide 102 text

Monitor everything watch high and low thresholds

Slide 103

Slide 103 text

SOA • Services make your life easier • Keep a layer in front of your models • Facade design pattern

Slide 104

Slide 104 text

View

Slide 105

Slide 105 text

View Models Database Load business objects

Slide 106

Slide 106 text

View Service Models Database Load business objects Business logic here

Slide 107

Slide 107 text

View Service Models Database Load business objects Business logic here

Slide 108

Slide 108 text

View Service Models Database Load business objects Business logic here

Slide 109

Slide 109 text

Rules of thumb • Keep views lean • Business logic in: • Models • Services • Validation logic in forms

Slide 110

Slide 110 text

No content

Slide 111

Slide 111 text

Danger

Slide 112

Slide 112 text

Domain pollution • When integrating with a 3rd party... • they will try and push their shortcomings into your platform

Slide 113

Slide 113 text

No content

Slide 114

Slide 114 text

Anti-corruption layer Your platform Their platform Anti-corruption layer

Slide 115

Slide 115 text

Summary • Django e-commerce is an emerging force • Customising django apps isn’t easy • Oscar’s future: • NoSQL • Table inheritance

Slide 116

Slide 116 text

Image credits Books: http://www.flickr.com/photos/th3ph17/3091294342/ More books: http://www.flickr.com/photos/cheryl-j/3965942320/ Nail varnish: http://www.flickr.com/photos/greenzowie/5451402463/ Leather gloves: http://www.flickr.com/photos/theopenseas/175598276/ Lego shipping: http://www.flickr.com/photos/lydiashiningbrightly/5356210011/ Rubber gloves: http://www.flickr.com/photos/recyclethis/139373445/ Warehouse: http://www.flickr.com/photos/23748404@N00/15648677/ Taxonomy: http://www.flickr.com/photos/kqedquest/831547339/ T-shirts: http://www.flickr.com/photos/blazerman/177165473/