IoT Museum by floriancourgey.com  

IoT Museum

Display random artworks on any screen. Meant to be used with a Raspberry Pi linked to a monitor for an in-house museum.

Demo available at https://iot-museum.herokuapp.com.

General instructions

• Make sure to have python 3 installed. You can get it from https://www.python.org/downloads/. Check the installation with python --version in a terminal:

$ python --version
Python 3.7.0

• Download the sources (on github, "Clone or download" > "Download ZIP").
• Extract
• Open a terminal in the extracted folder
• Follow instructions below, depending on your system:

Windows instructions

> pip install -r requirements.txt
> python manage.py runserver

• Open up a browser and go to http://localhost:8000

Linux, Mac instructions

$ source venv/bin/activate
(venv) $ pip3 install -r requirements.txt
(venv) $ python3 manage.py runserver

• Open up a browser and go to http://localhost:8000

Django management commands

$ manage.py makemigrations # creates .py files
$ manage.py migrate # execute migrations to db
$ manage.py crawler_rmngp # starts crawler

Config

Edit settings.py and config.py.

Project overview

• Project structure

- settings.py # project-wide settings
- config.py # api keys and database connection
- museum/ # hosts the main frontend interface
  - static/ # static CSS+JS files
  - templates/ # html
  - models.py # entity definition
  - views.py # controller
  - admin.py # admin interface
- crawler_*# crawlers as Django apps containing commands
- templates # overriden admin templates
- api # Django REST framework

• Server overview

/ # displays the main page with the artwork and a call every 5 sec to /next
/next # fetches a random artwork and display it as a JSON response
/reset # reset all timesPlayed to 0
/api/ # api from the Django REST framework

Access db via web Admin

Go to http://localhost:8000/admin and connect with admin/admin.

Access db via GUI

Download Sqlectron GUI and use the .db filepath as the "Initial Database":

Flask vs Django

Django is better for:

• SQLite migration (unable to easily edit a column with Flask)
• Models accessible easily in Django Commands (similar to Symfony Commands)
• Admin interface on /admin
• Lighter ORM syntax

Screenshots

CRUD interface

Add artwork from external sources (i.e. https://art.rmngp.fr/fr/)

Create a crawler

# create folder structure
$ python3 manage.py startapp crawler_rijks
# create admin page
$ touch museum/admin/python3 manage.py startapp crawler_rijks.html
# add view in museum/admin.py get_urls()
# add link in templates/admin/base.html