TODO.md

TODOs for Film2Subtitle API

I put future plans for this project in this file.

Completed ✅

• Implement user authentication using OAuth2 password flow.
  • Add settings for database (Host, Port, ...) and first superuser (Name, email, ...)
  • Create database utilities (crud operation generic classes) and models (SQLAlchemy ORM)
  • Create schemas for users and security payloads (e.g. access token)
  • Implement security utilities and dependencies for OAuth

Work in progress ⚒️

Planned 📝

• Add restriction to access /api/v1/subs endpoint to only authenticated users.
• Implement API parsers for movies and series page.
• Add a new method of searching subtitles that uses wp-json endpoint of the film2subtitle website. (e.g. for creating tokens and validating them)
• Clean up the examples in API schemas.
• Add support for adding custom headers/cookies to each request.
• Add proxy server support to the API handler to prevent the API from being blocked by the website.
• Add documentation on how to use the API.
• Add internal logging system.
• Add support for mailing system.
• Dockerize the project.
• Add database migration via Alembic.