Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To maintain order in Search GAIA API we added the pyproject.toml, this file serves as a central configuration file for Python projects, providing a standardized way to define project metadata, build configurations, dependency management, and other project-specific settings. It helps streamline project development, build processes, and collaboration among developers.


Step-by-step guide

For each new dependency 

  1. Execute pip install   <dependency>
  2. Go to pyproject.toml and look for the dependency section


  3. Add the new dependency into the array of dependencies in pyproject.toml

    Tip
    titleSpecify the dependencies version

    We recommend using version specific definition, if for some reason you need more flexibility on a dependency please check Dependency specifiers

  4. Once your library is in the dependencies section future developer will be able to install all necessary dependencies with

    Code Block
    pip install -e .
Note
titleWhy not use requirements.txt?

You can use requirements file, but we don't recommend this, the use of the pyproject ensures a double check on the dependencies to install, and ins


Why use Pyproject over Requirements file

The pyproject.toml file and requirements.txt serve different purposes when it comes to managing dependencies in Python projects. Here are some advantages of using pyproject.toml over requirements.txt:

...