Homepage

App structure

• https://github.com/apache/superset/tree/master/superset

Running in virtual environment

python -m venv .venv
pip install -r requirements.txt
flask  run --debug

Docker

1. python:latest image size - 931MB
2. basic configuration for development inside container size - 949MB, build within seconds
   1. dockerfile

   FROM python:latest
   ENV PYTHONUNBUFFERED 1
   WORKDIR /app
   COPY requirements.txt /app/requirements.txt
   RUN pip install -r requirements.txt
   COPY . /app
   

   2. docker-compose.yml

   version: '3.8'
   services:
   homepage:
       image: homepage
       container_name: homepage
       build:
       context: .
       dockerfile: dockerfile
       command: flask run --host=0.0.0.0 --debug
       ports:
       - 5000:5000
       volumes:
     - .:/app
   

3. multistage build -x MB
   1. dockerfile - There were some errors during building process, so I can't tell the difference in MB between images.

   FROM python:3.12.0a5-slim-bullseye as compile-image
   RUN apt-get update
   RUN apt-get install -y --no-install-recommends build-essential gcc
   RUN python -m venv /opt/venv
   ENV PATH="/opt/venv/bin:$PATH"
   COPY requirements.txt .
   RUN pip install -r requirements.txt
   RUN pip install setuptools
   COPY setup.py .
   COPY . .
   RUN pip install .
   
   FROM python:3.12.0a5-alpine3.17 as build-image
   COPY --from=compile-image /opt/venv /opt/venv
   
   ENV PATH="/opt/venv/bin:$PATH"
   

Models

• Post - Used for keeping articles/posts
• Tag - 1:n relation with post
• User - There is only one user in db. Registration is impossible.

Endpoints

• GET /posts

• POST /posts

• GET /posts/str:tag

• DEL /posts/int:id

• PATCH /posts/int:id

• PUT /posts/int:id

• GET /posts/tags

• POST /auth/login - /auth/ endpoints are meant to be accessed by admin. Operations altering state of the database like POST, PUT, PATCH, DELETE must be performed by a logged user.

• GET /auth/logout

postgres

• psql -U postgres -> enter postgres as user = "postgres"
• psql - in /bin/bash -> enter postgres cmd
• \l list databases
• DROP DATABASE ;
• \c db_name - switch to db_name
• \dt - list tables
• \d describe table
• DROP TABLE ;
• \q - quit from psql

full docker-compose.yml

version: '3.8'
services:
  db:
    image: postgres:latest
    container_name: homepage-postgres-db
    env_file:
      - .env
    ports:
      - '5432:5432'
    restart: on-failure
    volumes:
      - postgres-db:/var/lib/postgresql/data
  homepage:
    image: homepage
    container_name: homepage
    build:
      context: .
      dockerfile: dockerfile
    command:  flask run --host=0.0.0.0 --debug
    ports:
      - 5000:5000
    volumes:
      - .:/app
    depends_on:
      - db
volumes:
  postgres-db: