Skip to content

Conversation

Copy link

Copilot AI commented Aug 26, 2025

This PR addresses the need for comprehensive dependency management and documentation across all project directories in the openfoodfacts-ai repository.

What's Changed

Added README.md files to 13 directories:

  • GSoC2018/, circular-net-model/, data-quality/, front-image-classification/
  • genai-features/, ingredient_extraction/, language_identification/, logo-ann/
  • logo-classifier/, ml_utils/, object_detection/, ocr_cleaning/, price-tag-dection/

Added dependency management files to 16 directories:

  • requirements.txt for most Python projects (GSoC2018, ai-emlyon, circular-net-model, data-quality, genai-features, ingredient_extraction, logo-classifier, object_detection, ocr_cleaning, price-tag-dection)
  • pyproject.toml for complex projects following existing patterns (nutrisight)
  • Meta requirements.txt for projects with existing subdirectory structure (logo-ann, front-image-classification)

Key Features

Consistent Documentation Structure:
Each README follows a standardized format with project description, installation instructions, usage examples, and file structure documentation.

Appropriate Dependency Management:

  • Analyzed existing code to determine accurate dependencies
  • Followed repository patterns (pyproject.toml for complex projects, requirements.txt for simpler ones)
  • Respected modern Python packaging standards including PEP 723 inline dependencies
  • Maintained compatibility with existing workflows

Comprehensive Coverage:

  • 18/18 directories now have README files
  • 17/18 directories have dependency management (ml_utils excluded as it contains only shell scripts)
  • All projects now have clear installation and usage instructions

Examples

Simple Python project (data-quality/requirements.txt):

openfoodfacts>=0.2.0
requests>=2.25.0
typer>=0.12.0
tqdm>=4.60.0
redis>=4.0.0
backoff>=2.0.0

Complex project with modern packaging (nutrisight/pyproject.toml):

[project]
name = "nutrisight"
version = "0.1.0"
description = "Nutrition information extraction from food product images"
dependencies = [
    "transformers>=4.20.0",
    "datasets>=2.0.0",
    "evaluate>=0.4.0",
    # ... additional dependencies
]

The changes maintain backward compatibility while providing clear paths for new contributors to get started with any project in the repository.

Fixes #374.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copy link
Author

Copilot AI commented Aug 26, 2025

@teolemon 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Copilot AI changed the title [WIP] Adding dependancy management and a helpful README file to all directories Add dependency management and README files to all project directories Aug 26, 2025
Copilot AI requested a review from teolemon August 26, 2025 10:28
Copilot finished work on behalf of teolemon August 26, 2025 10:28
@teolemon teolemon changed the title Add dependency management and README files to all project directories docs: Add dependency management and README files to all project directories Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adding dependancy management and a helpful README file to all directories

2 participants