-
Couldn't load subscription status.
- Fork 0
feat: Add FastAPI service for document redlining #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: JSv4/bump-version-and-add-note-to-docs
Are you sure you want to change the base?
feat: Add FastAPI service for document redlining #3
Conversation
…-docs Bump version and add notes to README.
…ag is passed to the constructor. Also updated the docs to fix a typo with quickstart.
The code has been updated to include support for macOS in the build and extraction process of the project. A new section is added to perform build and compression for macOS, in addition to existing mechanisms for Windows and Linux. The extraction method in engines.py is also modified to handle macOS specific binaries.
Fix binary extraction flow
…inaries out of VCS
Improve Build and Dist Infrastructure
Add ARM support
Merge pull request JSv4#9 from ross-mcnairn-dev/main
Parametrise target
This commit introduces a FastAPI application to provide a web interface for the document redlining functionality. The key features of this change are: - A FastAPI application with two endpoints: - `/redline/single`: Accepts two `.docx` files and returns a single redlined document. - `/redline/double`: Accepts two `.docx` files and returns a zip archive with two redlined documents (original vs. modified and modified vs. original). - API token authentication to secure the endpoints. - A 10MB file size limit to prevent abuse. - A `Dockerfile` and `docker-compose.yml` for easy containerization and deployment. - An updated build script (`build_differ.py`) to correctly build and package the C# binaries for multiple platforms. - Comprehensive tests for the new API endpoints, including tests for authentication and file size limits. - An updated `pyproject.toml` to manage dependencies and configure the test environment. - A `.gitignore` file to exclude build artifacts and environment files. - A `.env.example` file to provide a template for setting the API token.
| 👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. |
| Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
This change adds a FastAPI service to the project, allowing users to perform document redlining through a web API. The service is containerized using Docker and includes API token authentication and a file size limit for security.
The following changes are included:
src/python_redlines/api.py.Dockerfileanddocker-compose.ymlfor containerization.pyproject.toml.tests/test_api.py.build_differ.py..gitignorefile to exclude build artifacts..env.examplefile for environment variable configuration.PR created automatically by Jules for task 9152917385086058746