Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Yorkie Intellgence python migration #446

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
243 changes: 243 additions & 0 deletions yorkie-intelligence/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,macos,linux
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,python,macos,linux

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### macOS Patch ###
# iCloud generated files
*.icloud

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide

# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,macos,linux
9 changes: 9 additions & 0 deletions yorkie-intelligence/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.9.2
hooks:
# Run the linter.
- id: ruff
# Run the formatter.
- id: ruff-format
29 changes: 29 additions & 0 deletions yorkie-intelligence/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Yorkie Intelligence(WIP)

## Setting
install python 3.10.* version(recommend using [pyenv](https://github.com/pyenv/pyenv))<br/>
install [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)<br/>


### dev

```sh
poetry install --no-root
```

### prod

```sh
poetry install --without dev
```

## How To Start

```sh
git clone https://github.com/yorkie-team/codepair.git
cd yorkie-intalligence
poetry run uvicorn src.main:app --reload
```

you can see openapi in http://localhost:8000/docs

Empty file.
29 changes: 29 additions & 0 deletions yorkie-intelligence/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[tool.poetry]
name = "yorkie-intelligence"
version = "0.1.0"
description = ""
authors = ["Your Name <[email protected]>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.10"
fastapi = "^0.115.6"
uvicorn = "^0.34.0"
langchain = "^0.3.14"
langchain-openai = "^0.3.0"
langchain-ollama = "^0.2.2"
python-dotenv = "^1.0.1"
pydantic-settings = "^2.7.1"


[tool.poetry.group.dev.dependencies]
pre-commit = "^4.0.1"
pytest = "^8.3.4"
pytest-asyncio = "^0.25.3"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.ruff.lint]
ignore = ["F401"]
3 changes: 3 additions & 0 deletions yorkie-intelligence/src/.env.deployment
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
MODEL_TYPE="ollama"
MODEL_NAME="smollm2:135m"
API_KEY="<your-api-key>"
Comment on lines +1 to +3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Improve environment file security and documentation.

  1. The API key should not be committed to version control
  2. Add documentation for each configuration option
  3. Consider providing validation hints

[refactor_suggestion_essential]

Create a .env.deployment.example file instead:

-MODEL_TYPE="ollama"
-MODEL_NAME="smollm2:135m"
-API_KEY="<your-api-key>"
+# Type of model to use (options: "ollama", "openai")
+MODEL_TYPE="ollama"
+
+# Name/version of the model to use
+MODEL_NAME="smollm2:135m"
+
+# API key for authentication (required for OpenAI models)
+# DO NOT commit the actual API key to version control
+API_KEY=""

Then:

  1. Add .env.deployment to .gitignore
  2. Document the setup process in README.md
  3. Require users to copy .env.deployment.example to .env.deployment and fill in their values
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
MODEL_TYPE="ollama"
MODEL_NAME="smollm2:135m"
API_KEY="<your-api-key>"
# Type of model to use (options: "ollama", "openai")
MODEL_TYPE="ollama"
# Name/version of the model to use
MODEL_NAME="smollm2:135m"
# API key for authentication (required for OpenAI models)
# DO NOT commit the actual API key to version control
API_KEY=""

11 changes: 11 additions & 0 deletions yorkie-intelligence/src/api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from fastapi import APIRouter

from src.api.pr import router as pr_router
from src.api.issue import router as issue_router
from src.api.write_document import router as doc_router
Comment on lines +1 to +5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use relative imports for internal modules.

The current absolute imports starting with 'src' may cause issues when the package is installed. Consider using relative imports for internal modules.

Apply this diff to improve the imports:

 from fastapi import APIRouter
 
-from src.api.pr import router as pr_router
-from src.api.issue import router as issue_router
-from src.api.write_document import router as doc_router
+from .pr import router as pr_router
+from .issue import router as issue_router
+from .write_document import router as doc_router
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
from fastapi import APIRouter
from src.api.pr import router as pr_router
from src.api.issue import router as issue_router
from src.api.write_document import router as doc_router
from fastapi import APIRouter
from .pr import router as pr_router
from .issue import router as issue_router
from .write_document import router as doc_router


router = APIRouter()

router.include_router(pr_router, prefix="/pr")
router.include_router(issue_router, prefix="/issue")
router.include_router(doc_router, prefix="/doc")
Comment on lines +9 to +11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about integrating these APIs into a single file using a path parameter?

Since all actions appear to be the same, with only the prompt differing, integrating them could improve scalability. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now, only few show prompt is applied all these, but I think, in the future, each function can be implemented by different way to enhancement the model performance(ex. refering a vectordb, using langgraph agent). so, IMO if we have a plan to change the method, separating api is better choice.

1 change: 1 addition & 0 deletions yorkie-intelligence/src/api/issue/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from .views import router
Loading