Your Repo as an Importable Package

So, what’s the deal with the command pip install -e, and why is it a game-changer for our project?

The pip install -e command is your ticket to installing a Python package in “editable” mode. In simpler words, this means you can tweak the source code of your package, and voila! Your changes take effect immediately in it, no reinstallation needed.

Now, the presence of a setup.py file is your project’s golden ticket, especially in the realm of creating packages for AI projects. This file is like the control center, handling configuration and metadata for packaging your AI code into a distributable format, often taking the form of a Python package. It lets you specify dependencies, version information, and other crucial details essential for a smooth installation and usage process.

In a nutshell, doing this the right way allows you to treat your code just like any other Python library. The real magic happens when you realize you can seamlessly manage your source control and develop your code within the container. Everything neatly in the same place!

The next setup.py file was gotten from our llamaindex-project repository.

from setuptools import setup, find_packages

setup(
    name='llamaindex-project',
    version='0.1.0',
    author= 'Santiago Olivar',
    author_email='contact.bubl.ai@gmail.com',
    description='',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/bubl-ai/llamaindex-project',
    license='MIT',
    classifiers=[
        'Development Status ::Planning',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Topic :: Software Development :: Libraries :: Python Modules',
        'Operating System :: OS Independent',
    ],
    package_dir={'': 'bubls'} # Need it this way as we are installing it in editable mode
)