Navigation

• Job Metadata and Job Status
• Global requirements
• Run in Docker
• Run locally

DEVELOPMENT

Job Metadata and Job Status

Backend and Frontend need to use metadata about the "job" we are doing. Jobs have "status" in the metadata, like "CREATED", or "DONE". They need to be synchornized between the Backend and Frontend, as well as inside all our Azure functions (API, DOWNLOADER, NLP, etc...). So, we need to use Enums, in order to not kill ourselves.

Values are located in /TechVibe/functions/shared/job_status.py:

class JobStatus(Enum):
    DOWNLOADED = "DOWNLOADED"
    TRANSCRIBED = "TRANSCRIBED"
    DONE = "DONE"
    CREATED = "CREATED"
    ERROR = "ERROR"

Example usage:

def _finalize(self):
        """
        Update status to DOWNLOADED and enqueue to DOWNLOADED_QUEUE.
        """
        self.job_metadata["status"] = JobStatus.DOWNLOADED.value

They need to stay the same between our Python backend and TS Frontend - if you are making changes.

Global requirements

• Python 3.10+
• Docker
• Azure Functions Core (start azure functions)

follow instructions to install: Azurite-Margarite

• Azurite (local cloud - storage and queue) - mount on docker

docker pull mcr.microsoft.com/azure-storage/azurite

• Azure Storage Explorer (peek view for storage and queue)

follow instructions to install: Another Azury linky

Then connect locally: "Attach to a local emulator" on default values.

---

Run in Docker

1. Navigate to the root folder
2. Run with frontend service: docker-compose --profile frontend up --build
3. run without the frontend service: docker-compose up --build

Everything is expose nicely, ports:

• Frontend 8080
• Backend 7071

---

Run locally

Run azurite

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite

Run functions

cd functions
python3 -m venv .venv
chmod a+x ./.venv/bin/activate
source ./.venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
func start

Test storage and queue

curl -X POST http://localhost:7071/api/downloader -d @body.json -v

After this you should see new file in Storage Explorer: local-1/BlobContainer/results