Skip to content

BSStudio/bss-web-file-api

Repository files navigation

Docker Integration test Python GitHub Release Date GitHub Tag GitHub branch checks state Codecov branch GitHub code size in bytes GitHub Bugs Code Smells Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities

BSS Web File Server

This project aims to help the video upload process. It will create folders for each member and video based on their uuid.

Development

Pre-requisites

  1. Install python (see version in pyproject.toml)
  2. Install uv
uv sync

Set up commit hooks

pre-commit install

Run server

uv run uvicorn src.bss_web_file_server.main:app

Lint

uv run isort . --check
uv run black . --check
uv run mypy
uv run pylint src

Apply lint

uv run isort .
uv run black .

Run development server

uv run uvicorn src.bss_web_file_server.main:app --reload

Test

uv run pytest

Integration Test

uv run pytest tests-int

See .github/workflows/integration.yml for CI/CD example with GitHub Actions.

Build docker image

docker build -t bss_web_file_server .

Run docker compose

docker-compose up