Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: benyounes-sadokaziz
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 50.3 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 6
  • Releases: 0
Created 11 months ago · Last pushed 8 months ago
Metadata Files
Readme Contributing Funding License Citation Security

README.md

🤟 PCD — NLP to Sign Language Video Translator PCD is a full-stack application that enables users to input text, audio, or video, and receive a corresponding sign language translation in video format. It leverages speech-to-text, natural language processing (NLP), and sign video matching to provide accessible communication tools, especially for the deaf and hard-of-hearing community.

🧠 Core Features 🔐 Authentication: Secure user registration and login

🧾 About Page: Overview of the project and its purpose

🕓 History Page: View your transcription and translation history

🗣️ Multimodal Input:

Upload an audio or video file

Record live speech in the browser

Directly input a sentence in text form

🧠 NLP Processing:

Converts speech to text using a speech recognition model

Cleans and analyzes text with a custom NLP pipeline

🤟 Sign Language Video Output:

Matches phrases to corresponding sign language videos

Displays result via an embedded video player

🧩 PostgreSQL Database: Stores user data, uploads, and history

🧭 How It Works text Copy Edit User → [Text | Audio | Video] Input → [Speech-to-Text if needed] → NLP Pipeline processes the text → Phrase matching + video retrieval → Video of corresponding sign language is displayed 📁 Project Structure bash Copy Edit / ├── app/ # FastAPI backend: routes, models, processing ├── front_js/ # Frontend: HTML/JS interface ├── static/videos/ # Pre-rendered sign language video clips ├── uploads/ # Temporarily stores uploaded media ├── docs/ # Project documentation ├── scripts/ # Helper scripts (optional) ├── pyproject.toml # Project setup (PDM) ├── requirements.txt # Python dependencies └── README.md # You are here! ⚙️ Tech Stack Layer Tech 🧠 NLP Custom matching, Whisper (for STT) 🧾 Backend FastAPI 🎛 Frontend JavaScript / HTML 🗄 Database PostgreSQL 🎥 Sign Output Pre-rendered avatar videos (Unity/Mixamo or similar)

🚀 Getting Started 🔧 Requirements Python 3.9+

PostgreSQL (running locally or in Docker)

PDM or pip for dependency management

🐍 Backend Setup bash Copy Edit git clone https://github.com/benyounes-sadokaziz/PCD.git cd PCD

Create virtual environment

python -m venv venv source venv/bin/activate

Install Python packages

pip install -r requirements.txt

Set up .env for DB connection (example below)

⚙️ .env Example ini Copy Edit DATABASEURL=postgresql://user:password@localhost:5432/pcd SECRETKEY=yoursecretkey Then run:

bash Copy Edit uvicorn app.main:app --reload Visit:

Swagger UI: http://127.0.0.1:8000/docs

Main frontend: Open index.html in the browser (in front_js/)

🧾 Pages Overview / → Home page (Input UI: text/audio/video)

/about → About the project and its purpose

/history → View your previous transcriptions & translations

/docs → Interactive API documentation (Swagger UI)

📌 Future Improvements Real-time avatar signing with Unity or WebGL

Support for multiple sign languages (LSF, ASL, etc.)

Enhanced semantic matching using transformer models

User feedback collection & rating for translations

📄 License This project is open-source under the MIT License. See LICENSE for full details.

🤝 Contributing We welcome contributions! Feel free to:

Fork the repository

Create a branch (feature/your-feature)

Submit a pull request

Owner

  • Login: benyounes-sadokaziz
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: FastAPI
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Sebastián
    family-names: Ramírez
    email: tiangolo@gmail.com
identifiers:
repository-code: 'https://github.com/fastapi/fastapi'
url: 'https://fastapi.tiangolo.com'
abstract: >-
  FastAPI framework, high performance, easy to learn, fast to code,
  ready for production
keywords:
  - fastapi
  - pydantic
  - starlette
license: MIT

GitHub Events

Total
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 3
  • Public event: 1
  • Pull request event: 2
  • Create event: 2
Last Year
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 3
  • Public event: 1
  • Pull request event: 2
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 months
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2) github_actions (1) python (1)

Dependencies

.github/workflows/add-to-project.yml actions
  • actions/add-to-project v1.0.2 composite
.github/workflows/build-docs.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • astral-sh/setup-uv v5 composite
  • dorny/paths-filter v3 composite
  • re-actors/alls-green release/v1 composite
.github/workflows/contributors.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/deploy-docs.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • cloudflare/wrangler-action v3 composite
.github/workflows/issue-manager.yml actions
  • tiangolo/issue-manager 0.5.1 composite
.github/workflows/label-approved.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
.github/workflows/labeler.yml actions
  • actions/labeler v5 composite
  • docker://agilepathway/pull-request-label-checker latest composite
.github/workflows/latest-changes.yml actions
  • actions/checkout v4 composite
  • mxschmitt/action-tmate v3 composite
  • tiangolo/latest-changes 0.3.2 composite
.github/workflows/notify-translations.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/people.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pypa/gh-action-pypi-publish v1.12.4 composite
.github/workflows/smokeshow.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
.github/workflows/sponsors.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/test-redistribute.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • re-actors/alls-green release/v1 composite
.github/workflows/test.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • astral-sh/setup-uv v5 composite
  • re-actors/alls-green release/v1 composite
.github/workflows/topic-repos.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
pyproject.toml pypi
  • pydantic >=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0
  • starlette >=0.40.0,<0.47.0
  • typing-extensions >=4.8.0
requirements-docs-insiders.txt pypi
requirements-docs-tests.txt pypi
  • httpx >=0.23.0,<0.28.0 test
  • ruff ==0.11.2 test
requirements-docs.txt pypi
  • black ==25.1.0
  • cairosvg ==2.7.1
  • griffe-typingdoc ==0.2.7
  • jieba ==0.42.1
  • markdown-include-variants ==0.0.4
  • mdx-include >=1.4.1,<2.0.0
  • mkdocs-macros-plugin ==1.3.7
  • mkdocs-material ==9.6.1
  • mkdocs-redirects >=1.2.1,<1.3.0
  • mkdocstrings ==0.26.1
  • pillow ==11.1.0
  • pyyaml >=5.3.1,<7.0.0
  • typer ==0.12.5
requirements-github-actions.txt pypi
  • PyGithub >=2.3.0,<3.0.0
  • httpx >=0.27.0,<0.28.0
  • pydantic >=2.5.3,<3.0.0
  • pydantic-settings >=2.1.0,<3.0.0
  • pyyaml >=5.3.1,<7.0.0
  • smokeshow *
requirements-tests.txt pypi
  • PyJWT ==2.8.0 test
  • anyio >=3.2.1,<5.0.0 test
  • coverage >=6.5.0,<8.0 test
  • dirty-equals ==0.9.0 test
  • flask >=1.1.2,<4.0.0 test
  • inline-snapshot ==0.19.3 test
  • mypy ==1.8.0 test
  • passlib >=1.7.2,<2.0.0 test
  • pytest >=7.1.3,<9.0.0 test
  • pyyaml >=5.3.1,<7.0.0 test
  • sqlmodel ==0.0.23 test
  • types-orjson ==3.6.2 test
  • types-ujson ==5.10.0.20240515 test
requirements-translations.txt pypi
  • pydantic-ai ==0.0.30
requirements.txt pypi
  • playwright *
  • pre-commit >=2.17.0,<5.0.0