Skip to content

feat: Improve compliance ocumentation and repository standards

Garela Akshaya requested to merge compliance into main

Summary

This merge request improves the repository’s open-source compliance readiness for the Swecha Projects Compliance Checker.

Changes

  • Added AGPL-3.0-only license metadata.
  • Improved README with project overview, setup, usage, configuration, privacy, security, roadmap, and license details.
  • Added CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, and CHANGELOG files.
  • Added Python project metadata in pyproject.toml.
  • Added GitLab CI and GitHub Actions validation workflows.
  • Added GitLab issue and merge request templates.
  • Added GitHub issue and pull request templates.
  • Improved .gitignore for Python, local databases, generated PDFs, secrets, caches, and editor files.
  • Updated USER_MANUAL with current app workflow.
  • Added .env.example entry for GEMINI_API_KEY.
  • Fixed Python syntax issues in app.py and modules/translator.py so compile checks pass.

Validation

  • Created virtual environment
  • Installed dependencies from requirements.txt
  • Ran python3 -m compileall app.py modules
  • Ran python3 -m pip check
  • Started Streamlit app successfully
  • Confirmed app responds at http://localhost:8501

Merge request reports