Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.12 KB

README.md

File metadata and controls

68 lines (44 loc) · 3.12 KB
Raw

Projekt PANOPTIKUM

This is a web application that converts CSV files to an API with search and filtering. It has been used to create a digital collection of artworks, but could be used for essentially any data that is described using a Data Package. Find out more on the Open Knowledge Blog.

Made with Frictionless Data, Flask, Bootstrap and LightGallery.

Deployment

  1. Install pipenv: python3 -m pip install pipenv
  2. pipenv --python 3
  3. pipenv shell
  4. pipenv sync
  5. flask run
sudo apt-get install python3.8 python3-numpy
virtualenv --system-site-packages -p python3.8 env
pip install -r requirements.txt

Data refresh

To update the metadata, we run this script from the pipenv shell:

python collect.py

This script expects a data/WERKVERZEICHNIS.csv which is the UTF-8 encoded conversion of the source Excel file. It creates (or refreshes) a Data Package specification by inferring schema from the data using Data Package Pipelines.

The script also checks that images are present in the images folder. You may want to prepare the images first, if this is part of your use case. Otherwise, look at the source code to fit the process to your data.

Image collection

The convert utility from ImageMagick is required for this process.

Use the convert.sh script to prepare an images folder with consistent formats (JPEG) and resolutions (720p).

Then use thumbs.sh to generate thumbnails.

The scripts skip any files that are already present, and can be used for updates.

Running

In development, use:

env FLASK_DEBUG=1 flask run

In production, something like:

gunicorn --log-level=info -w 4 -b :8000 app:app

Adding new images

  • Open the new WERKVERZEICHNIS.xlsx in Calc and save as CSV, using UTF-8 as encoding, , as delimiter, " as quotation and enabling quote all text cells. This should produce a file WERKVERZEICHNIS.csv.
  • Download all existing images: rsync -azP [email protected]:/var/lib/dokku/data/storage/archiv/images/ ./images/
  • Place any new image files in the IMPORT folder and rename them to 'WV_neu_$date_ersatz' or 'WV_neu_$date'
  • Remove metadata files by cd-ing into the IMPORT folder and running find . -name '.*_*' | xargs -d '\n' rm
  • Rename the newly imported folders with increasing numbers
  • Crop and resize the images by running ./convert.sh
  • Generate thumbnails by running ./thumbs.sh
  • Create the virtualenv and install the requirements as described above
  • Run python collect.py
  • Feed back the converted images to the server: rsync -azP ./images/ [email protected]:/var/lib/dokku/data/storage/archiv/images/

Adding new filters

  • Add the new filter to data/filters.csv manually, and run python collect.py to update the count