https://github.com/bsstudio/bss-web-file-api

https://github.com/bsstudio/bss-web-file-api

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bsstudio/bss-web-file-api
• Owner: BSStudio
• License: gpl-3.0
• Created: 2022-11-14T15:29:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-05-24T04:19:37.000Z (11 days ago)
• Last Synced: 2026-05-24T06:37:01.707Z (11 days ago)
• Language: Python
• Homepage: https://app.circleci.com/pipelines/github/BSStudio/bss-web-file-api
• Size: 1.84 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Docker](https://github.com/BSStudio/bss-web-file-api/actions/workflows/docker.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/docker.yml)

[![Integration test](https://github.com/BSStudio/bss-web-file-api/actions/workflows/integration.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/integration.yml)

[![Python](https://github.com/BSStudio/bss-web-file-api/actions/workflows/python.yml/badge.svg)](https://github.com/BSStudio/bss-web-file-api/actions/workflows/python.yml)

![GitHub Release Date](https://img.shields.io/github/release-date/BSStudio/bss-web-file-api)

![GitHub Tag](https://img.shields.io/github/v/tag/BSStudio/bss-web-file-api)

![GitHub branch checks state](https://img.shields.io/github/checks-status/BSStudio/bss-web-file-api/main)

![Codecov branch](https://img.shields.io/codecov/c/gh/BSStudio/bss-web-file-api/main)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/BSStudio/bss-web-file-api)

![GitHub](https://img.shields.io/github/license/BSStudio/bss-web-file-api)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=bugs)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=code_smells)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=ncloc)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=alert_status)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=security_rating)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=sqale_index)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=BSStudio_bss-web-file-api&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=BSStudio_bss-web-file-api)

# 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](https://docs.astral.sh/uv/)

```shell

uv sync

```

### Set up commit hooks

```shell

pre-commit install

```

## Run server

```shell

uv run uvicorn src.bss_web_file_server.main:app

```

### Lint

```shell

uv run isort . --check

uv run black . --check

uv run mypy

uv run pylint src

```

#### Apply lint

```shell

uv run isort .

uv run black .

```

### Run development server

```shell

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

```

### Test

```shell

uv run pytest

```

### Integration Test

```shell

uv run pytest tests-int

```

See [`.github/workflows/integration.yml`](.github/workflows/integration.yml) for CI/CD example with GitHub Actions.

### Build docker image

```shell

docker build -t bss_web_file_server .

```

### Run docker compose

```shell

docker-compose up

```