Skip to content

Fix repository configuration and dependency issues #26

Description

@mr-adonis-jimenez

Issues to Fix

1. Missing Dependencies in requirements.txt

The requirements.txt file only contains fastapi but is missing essential dependencies referenced throughout the codebase:

  • uvicorn (required to run the FastAPI app)
  • pandas (used in analytics.py)
  • python-multipart (needed for file uploads)
  • Other packages listed in pyproject.toml

Action: Sync requirements.txt with dependencies from pyproject.toml

2. Broken README Badges

The npm version and CI workflow badges contain placeholder URLs:

  • ![npm](https://img.shields.io/npm/v/your-package) - references "your-package"
  • ![CI](https://github.com/you/repo/actions/workflows/npm-publish.yml/badge.svg) - references "you/repo"

Action: Remove npm badge (this is a Python project) and fix CI badge URL to point to actual workflows in this repository

3. Incorrect CODEOWNERS Location

The CODEOWNERS.md file is in the root directory but should be at .github/CODEOWNERS (without the .md extension) to function properly with GitHub's code ownership features.

Action: Move CODEOWNERS.md to .github/CODEOWNERS and remove .md extension

4. Branch Name Inconsistency

The README and CONTRIBUTING.md reference the master branch, but modern GitHub repositories use main as the default branch.

Action: Update all references from master to main

5. Duplicate GitHub Directory

There are both .github and GitHub directories, creating confusion and potential workflow conflicts.

Action: Review contents of both directories and consolidate into .github only


Priority

High - These issues affect repository functionality, CI/CD pipeline, and developer experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions