https://github.com/siddhant-k-code/contextify

Python script designed to streamline the process of providing context to Large Language Models (LLMs) from your project files. It's particularly useful when working on coding tasks with LLMs, as it can automatically gather and format relevant code from your project.
https://github.com/siddhant-k-code/contextify

context contextify llm llm-inference python

Last synced: about 2 months ago
JSON representation

Python script designed to streamline the process of providing context to Large Language Models (LLMs) from your project files. It's particularly useful when working on coding tasks with LLMs, as it can automatically gather and format relevant code from your project.

• Host: GitHub
• URL: https://github.com/siddhant-k-code/contextify
• Owner: Siddhant-K-code
• License: mit
• Created: 2024-09-06T03:30:53.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T03:39:41.000Z (5 months ago)
• Last Synced: 2024-11-24T20:49:00.918Z (about 2 months ago)
• Topics: context, contextify, llm, llm-inference, python
• Language: Python
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Contextify

Contextify is a Python script designed to streamline the process of providing context to Large Language Models (LLMs) from your project files. It's particularly useful when working on coding tasks with LLMs, as it can automatically gather and format relevant code from your project.

## Features

- Selectively processes files in a directory, respecting `.gitignore` patterns

- Focuses on TypeScript files (`.ts` and `.tsx`)

- Ignores common directories and files that typically don't need to be included

- Outputs processed file contents in Markdown format

- Saves output to a Markdown file

## Requirements

- Python 3.x

## Usage

1. Place the `contextify.py` file in your project directory or set the `directory_path` variable in the script to point to your project directory.

2. Run the script:

   ```

   python contextify.py

   ```

3. The script will process the files and:

   - Print the output to the console

   - Save the output to `output.md` in the same directory

## Customization

You can customize the script by modifying the following variables:

- `directories_to_ignore`: List of directories to exclude from processing

- `files_to_ignore`: List of specific files to exclude from processing

- `extensions_to_include`: List of file extensions to include (currently set to `.ts` and `.tsx`)

## How It Works

1. The script walks through the specified directory and its subdirectories.

2. It filters files based on the ignore lists and included extensions.

3. For each included file, it reads the content and formats it in a Markdown code block.

4. The formatted content is collected in a single string.

5. The resulting string is printed, saved to a file.