Python Project Template

Add your files here

Attention

The test and linting action will check for coverage minimum of 50%.

The COVERAGE.md file is automatically generated.

Makefile

Ready to work

make updatepip (install needed packages)

Make sure pipenv is installed before run this command.

pip install --user pipenv

Running $ pipenv lock then $ pipenv sync.
Locking [dev-packages] dependencies…
Locking [packages] dependencies…
Updated Pipfile.lock (18d334)!
Installing dependencies from Pipfile.lock (18d334)…
  🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 23/23 — 00:00:07

make test (run unit tests)

python -m unittest
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

make coverage (run unit tests and generates COVERAGE.md)

bash .github/scripts/generate_coverage.sh
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK
Wrote XML report to coverage.xml

make requirements (updates requirements.txt)

pipreqs --force
INFO: Successfully saved requirements file in /home/guionardo/dev/github.com/guionardo/python-template/requirements.txt

Sequence Diagram

sequenceDiagram
  title Wee Media Receiver Service
  autonumber
  actor front as Frontend
  participant back as API
  participant worker as Worker
  participant storage as Storage S3
  participant db as Database
  participant prc_img as Image Processor
  participant prc_vid as Video Processor

  front->>back: upload request
  alt is valid data
    activate back
    back-->>front: accepted {storage public URL}
    back->>storage: publish file 
    activate worker
    back->>worker: notify received file 
    worker->>db: insert media into database    
    worker->>worker: enqueeue notification
    deactivate worker
    deactivate back
  else no valid data
    back-->>front: rejected
  end

  loop read notifications
    note over worker: identify media type
    alt media is image
      activate prc_img
      worker->>prc_img: Process image
      note over prc_img: identify content
      note over prc_img: resize/optimize
      prc_img->>storage: update content/tagging/media_type
      prc_img->>db: update media infos and tags
      prc_img-->worker: returns
      deactivate prc_img
    else media is video
      activate prc_vid
      worker->>prc_vid: Process video
      note over prc_vid: identify content
      note over prc_vid: resize/optimize
      prc_vid->>storage: update content/tagging/media_type
      prc_vid->>db: update media infos and tags
      prc_vid-->worker: returns
      deactivate prc_vid

    end
  end

Priorização

POST /video/{id_video}

Identificar se o vídeo existe no S3
Existindo, retorna 202 ACCEPTED
Enfileira o id_video para processamento

Processamento

Download do vídeo do S3
Análise do conteúdo do vídeo e geração de tags
Análise e otimização do vídeo
Upload do novo vídeo para o S3
Notificação para o site bomperfil sobre o processo terminado do vídeo, com o novo nome de arquivo e as tags
Com o aceite do bomperfil, exclui o arquivo anterior do S3

Glossário

NAME	TYPE	EXAMPLE
MEDIA_URL	str	https://teste-videos.us-east-1.linodeobjects.com/teste-videos/uploads/2022/06/test_2.mp4
MEDIA_ID	str	uploads/2022/06/test.mp4
POST_ID	int	1234
NEW_MEDIA_ID	str	uploads/2022/06/test.webm
LOCAL_FILENAME	str	/tmp/filexxxx
LOCAL_NEWFILENAME	str	/tmp/fileYYYY

guionardo/wee-media-receiver