DEVELOPMENT.md

Developer Readme

This document contains documentation intended for developers of rag_semantic_chunking.

Pre-requisites:

• Docker

First time setup

If you're creating rag_semantic_chunking for the first time, you'll need to configure your local development environment along with the remote repository.

You can do this by simply running:

make -f initial-project-setup.mk project-setup

This will install Python 3.10 using PyEnv, create a virtual environment using Poetry, install and update pre-commit hooks, create and push a develop branch, and finally, remove the initial-project-setup file.

Note: the initial-project-setup process will check whether pre-commits, pyenv, and poetry are installed. If not, it will ask to install them on your behalf as they're required to use this template.

Developer environment setup

To work on the rag_semantic_chunking as a developer, you'll need to configure your local development environment. You can do this by simply running:

make project-setup

This will install Python 3.10 using PyEnv, create a virtual environment using Poetry, and install the pre-commit hooks.

Note: The project-setup process will check whether pre-commits, pyenv, and poetry are installed. If not, it will ask to install them on your behalf as they're required to use this template. The first time the project is set up, you should follow the instructions in First time setup.

A Makefile is just a usual text file to define a set of rules or instructions to run which can be run using the make command. To see the available make commands:

make help

Testing

With the poetry shell active (see above), you can run all the tests using:

make tests

Or specific tests:

python -m pytest tests/test_dummy.py