damj

damj

DAMJ เป็นเครื่องมือในการสร้างพรอมต์ที่ครอบคลุมสำหรับโมเดลภาษาโดยการรวมไฟล์โครงการและใช้ตัวเลือกการประมวลผลที่กำหนดเอง

การแนะนำ

damj ได้รับการออกแบบมาเพื่อช่วยให้นักพัฒนาสร้างพรอมต์ที่มีประสิทธิภาพสำหรับโมเดลภาษาขนาดใหญ่ (LLMS) เช่น ChatGPT ด้วยการรวมไฟล์โครงการที่แตกต่างกันและการใช้ตัวเลือกการประมวลผลที่ปรับแต่งได้ damj จะทำให้กระบวนการสร้างพรอมต์ที่ปรับให้เหมาะกับบริบทโครงการเฉพาะ

คุณสมบัติ

• รวมไฟล์โครงการหลายไฟล์ลงในพรอมต์เดียว
• ใช้ตัวเลือกการประมวลผลที่ปรับแต่งได้เพื่อรวม/ยกเว้นความคิดเห็นการนำเข้าและเอกสารสำหรับสคริปต์ Python
• สนับสนุนการประมวลผลสมุดบันทึก Jupyter และรวมถึงเอาต์พุตเซลล์
• การรวมและการใช้งานที่ง่ายภายในโครงการ Python

การติดตั้ง

จาก pypi

คุณสามารถติดตั้งรีลีสล่าสุดจาก PYPI:

pip install damj

จากแหล่งกำเนิด

git clone https://github.com/baselhusam/damj.git
cd damj
pip install . 

การใช้งาน

ตัวอย่างพื้นฐาน

 import os
from damj import Damj

cwd = os . getcwd ()
damj = Damj ( cwd )

damj . project_info (
    project_overview = "This is a sample project." ,
    add_project_structure = True ,
)

prompt = damj . create_prompt (
    question = "What is the purpose of this project?" ,
)

print ( prompt )

เอาท์พุท:

 # Project Overview
This is a sample project.


# Project Structure
|   ├── LICENSE
|   ├── README.md
|   ├── pyproject.toml
|   ├── requirements.txt
├── assets/
|   ├── background.png
|   ├── logo.png
├── damj/
|   ├── __init__.py
|   ├── damj.py
|   ├── utils.py



# Question
What is the purpose of this project?

รายละเอียดอีกอย่างหนึ่ง

 import os
from damj import Damj

cwd = os . getcwd ()

damj = Damj (
    cwd = cwd ,
    whitelist_files = [ "*.py" ],
    blacklist_files = [ ".venv" , "__pycache__" ],
    snippet_marker = "```"
)

damj . project_info (
    project_overview = "This is a sample project." ,
    add_project_structure = True ,
    add_files_content = True ,
    py_options = {
        "add_imports" : True ,
        "add_comments" : True ,
        "add_docstrings" : False ,
        "ipynb_output" : False
    }
)

prompt = damj . create_prompt (
    question = "What is the purpose of this project?" ,
    copy_to_clipboard = True ,
    to_markdown = False
)

print ( prompt )

ใช้ส่วนประกอบ damj utils

DAMJ ยังมีฟังก์ชั่นยูทิลิตี้หลายอย่างที่สามารถใช้งานได้อย่างอิสระ ยูทิลิตี้เหล่านี้รวมถึงฟังก์ชั่นเพื่อรับโครงสร้างโครงการรับเนื้อหาไฟล์และอื่น ๆ

รับโครงสร้างโครงการ

ฟังก์ชั่น get_project_structure สร้างการแสดงการทำเครื่องหมายของโครงสร้างไดเรกทอรีไม่รวมไฟล์ที่ขึ้นบัญชีดำและไดเรกทอรี

 from damj . utils import get_project_structure

# Get the project structure excluding .venv and __pycache__ directories
cwd = os . getcwd ()
blacklist = [ ".venv" , "__pycache__" ]
project_structure = get_project_structure ( cwd , blacklist )
print ( project_structure )

รับเนื้อหาไฟล์

ฟังก์ชั่น get_file_content ดึงเนื้อหาของไฟล์โดยใช้ py_options ที่ระบุ

 from damj . utils import get_file_content

py_options = {
    "add_comments" : True ,
    "add_imports" : True ,
    "add_docstrings" : False ,
    "ipynb_output" : False
}

# Get the content of a Python file with the specified options
file_content = get_file_content ( "example.py" , py_options )
print ( file_content )

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาตซอฟต์แวร์ Apache ดูไฟล์ใบอนุญาตสำหรับรายละเอียด

ผู้มีส่วนร่วม

Basel Mather ([email protected])

การบริจาค

ยินดีต้อนรับ! กรุณาแยกที่เก็บและเปิดคำขอดึงด้วยการเปลี่ยนแปลงของคุณ