Skip to content

refactor(structure): reorganize modules and improve documentation#15

Open
lore-is-already-taken wants to merge 4 commits into
ProtoAI-cl:mainfrom
lore-is-already-taken:main
Open

refactor(structure): reorganize modules and improve documentation#15
lore-is-already-taken wants to merge 4 commits into
ProtoAI-cl:mainfrom
lore-is-already-taken:main

Conversation

@lore-is-already-taken

Copy link
Copy Markdown
Contributor

Refactor codebase structure and improve code quality:

  • Reorganized Firebase module (moved to app/firebase/firestore.py)
  • Added comprehensive documentation with docstrings and inline comments
  • Applied PEP 8 formatting standards and improved code readability
  • Updated dependencies to latest versions and removed unused packages
  • Translated Spanish comments to English for consistency.

- Update core dependencies (fastapi, openai, uvicorn, etc.) to latest versions
- Remove unused dependencies to reduce package bloat
- Add new required dependencies (cryptography, grpcio-status, h2)
- Update firebase-admin package name and version
- Reorder imports following PEP 8 conventions
- Split long lines for better readability
- Add trailing commas and proper spacing
- Fix string concatenation style
- Add missing newlines at end of files
- Remove unused watchfiles dependency
… documentation

- Move firebase.py to app/firebase/firestore.py for better package organization
- Update import paths to reflect new module structure
- Add docstrings to all functions (get_emg_context, ping, websocket_server, upload_image)
- Add inline comments explaining code flow and functionality
- Translate Spanish comments to English for consistency
- Replace global Firestore initialization with FirestoreHandler class
- Add comprehensive logging configuration and structured logging
- Replace print statements with logger calls
- Improve error handling in Firestore initialization
- Add type hints for better code maintainability
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant