Description: Implement a Continuous Integration and Continuous Deployment (CI/CD) pipeline for our Python package hosted on PyPI and our Django web application. The pipeline should automate the process of testing, building, and deploying both the package and the application, ensuring a seamless and efficient workflow.

Tasks:

• Set up a GitHub Actions workflow for the Python package:

  • Run unit tests and linting checks on every push and pull request.

  • Build and publish the package to PyPI automatically on new releases.

• Set up a GitHub Actions workflow for the Django application:

  • Run unit tests, linting checks, and security scans on every push and pull request.

  • Deploy the application to the chosen hosting platform (e.g., Heroku, AWS, or GCP) automatically on new releases.

• Configure notifications to alert the development team about the status of the CI/CD pipeline, including any failed tests or deployment issues.

• Update project documentation to include information about the CI/CD pipeline, its requirements, and its usage.

• Provide training and support to the development team on how to effectively utilize the CI/CD pipeline and troubleshoot any issues that may arise.

By completing these tasks, we will significantly improve the development and deployment process for both our Python package and Django application, ensuring higher quality and more reliable releases.

It's nessesary to add documentation to project.

The documentation should include:

• Instructions on how to set up the project locally

• Explanation of any custom libraries or modules used in the project

• Contribution guidelines and code of conduct

I propose that we use a tool like Sphinxto generate the documentation, and we can host it on https://readthedocs.org/.

The files are not saved correctly.

Objective: Create a REST API for the existing Django application to provide users with programmatic access to its features and data.

Steps

• Design the API endpoints

  • Define the API endpoints and their corresponding request and response structures.

• Implement the API components

  • Create the API views, serializers, and URL routing for each endpoint.

• Add authentication and permissions

  • Ensure the security of the API by implementing authentication and permissions as needed.

• Test the API functionality

  • Verify that the API works as expected by testing each endpoint.

Enhance the user authentication and registration process to provide a better user experience, increased security, and easier management

Resolve an issue with the file upload functionality, which requires user authentication before uploading files. The problem is that the AJAX request does not redirect the user to the login page when not logged in.

Objective: Improve the quality and stability of the Django application by achieving full test coverage for all models, views, and utility functions.

Requirements:

• Analyze the current test coverage: Utilize a test coverage tool, such as Coverage.py, to determine which parts of the application are not covered by existing tests.

• Write unit tests: Create unit tests for all models, views, and utility functions that are not currently tested. Ensure that these tests cover edge cases and various input scenarios.

• Write integration tests: Develop integration tests to verify that the various components of the application work together as expected. This includes testing communication between different app modules, as well as any external APIs or services that the application relies on.

• Configure test settings: Update the Django project's settings to include a dedicated test configuration, including any necessary database settings, test runners, and other configurations specific to testing.

• Run tests continuously: Set up a continuous integration (CI) pipeline that automatically runs tests whenever changes are pushed to the codebase. This will help catch potential issues early in the development process.

• Document testing process: Update the project documentation, such as the README or a separate testing guide, to include information on running tests, the tools used for testing, and any necessary setup steps.

• Monitor and maintain test coverage: Regularly review test coverage reports to ensure that the application remains fully covered by tests as it evolves. Make any necessary updates to tests as the codebase changes.

Deliverables:

• A complete set of unit tests for all models, views, and utility functions in the Django application.
• A set of integration tests that verify the proper functioning of the application as a whole.
• An updated settings configuration for testing purposes.
• A continuous integration pipeline that runs tests automatically.
• Updated project documentation that includes information on testing, tools used, and setup instructions.
  By achieving full test coverage for the Django application, we will ensure that the application is more robust, reliable, and maintainable for future development.

Server unhealthy
Ran out of memory (used over 512MB) while running your code.

• Add memory usage profiling.

• Optimize memory usage - smaller variables if possible int8, max float16.

• Remove unnecessary objects.

• Apply generators where possible.

• Check whether to perform data processing in batches.

Train a machine learning model using a dataset and integrate it into the application to enhance its performance.

Deliverables:

• Trained machine learning model.

• Code changes for model integration.

• Updated project documentation.