Skip to content

Commit b3aa0c2

Browse files
committed
chore: Update project metadata and README for Lang2SQL
- Bump package version to 0.1.5 - Add author and repository information to setup.py - Update README with new project name and CLI usage details - Include DataHub GMS server configuration instructions
1 parent cbe19d4 commit b3aa0c2

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# AutoSQL
1+
# Lang2SQL
22

3-
AutoSQL은 자연어 입력을 기반으로 SQL을 생성하는 프로젝트입니다. LangGraph, DataHub를 활용하여 데이터를 분석하고 최적의 SQL 쿼리를 생성 및 최적화합니다.
3+
Lang2SQL은 자연어 입력을 기반으로 SQL을 생성하는 프로젝트입니다. LangGraph, DataHub를 활용하여 데이터를 분석하고 최적의 SQL 쿼리를 생성 및 최적화합니다.
44

55
## 📌 프로젝트 목표
66
1. 자연어 입력을 기반으로 SQL 쿼리를 자동으로 생성
@@ -34,16 +34,22 @@ python setup.py install
3434

3535
### 3️⃣ CLI 명령어 사용
3636

37-
설치 후, `autosql` 명령어를 사용할 수 있습니다. 예를 들어, Streamlit 앱을 실행하려면 다음과 같이 입력합니다:
37+
설치 후, `lang2sql` 명령어를 사용할 수 있습니다. 예를 들어, Streamlit 앱을 실행하려면 다음과 같이 입력합니다:
3838

3939
```bash
40-
autosql --run-streamlit
40+
lang2sql --run-streamlit
4141
```
4242

4343
기본 포트는 8501이며, 다른 포트를 사용하려면 `-p` 옵션을 사용하세요:
4444

4545
```bash
46-
autosql --run-streamlit -p 8502
46+
lang2sql --run-streamlit -p 8502
47+
```
48+
49+
DataHub GMS 서버 URL을 설정하려면 `--datahub_server` 옵션을 사용하세요. 기본값은 `http://localhost:8080`입니다:
50+
51+
```bash
52+
lang2sql --datahub_server http://your-datahub-server:8080 --run-streamlit
4753
```
4854

4955
### 4️⃣ 환경 변수 설정
@@ -69,15 +75,24 @@ LANGCHAIN_API_KEY=your-langchain-api-key
6975

7076
---
7177

72-
## 빌드 방법
78+
## 빌드 및 배포 방법
79+
80+
### 수동 빌드
7381

7482
```
7583
python setup.py sdist bdist_wheel
7684
twine upload dist/*
7785
```
7886

87+
### GitHub Actions를 통한 자동 배포
88+
89+
GitHub 저장소에 태그를 `v*` 형식으로 푸시하면, GitHub Actions가 자동으로 PyPI에 패키지를 배포합니다. 이 과정은 `.github/workflows/pypi-release.yml` 파일에 정의되어 있습니다.
90+
91+
- **태그 형식**: `v1.0.0`
92+
- **필요한 설정**: GitHub Secrets에 `PYPI_API_TOKEN`을 설정해야 합니다.
93+
7994
---
8095

81-
## 📄 라이선스
96+
## 라이선스
8297
MIT License
8398

setup.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66

77
setup(
88
name="lang2sql", # 패키지 이름
9-
version="0.1.4", # 버전
9+
version="0.1.5", # 버전
10+
author="ehddnr301",
11+
author_email="[email protected]",
12+
url="https://github.com/ehddnr301/lang2sql",
1013
description="Lang2SQL - Query Generator for Data Warehouse",
1114
long_description=long_description,
1215
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)