Skip to content

Commit d19eaa1

Browse files
authored
feat: typer cli (#24)
1 parent e2b9df2 commit d19eaa1

21 files changed

+163
-26
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,16 @@
2323
4. 프로젝트 versioning하고 changelog 자동 생성.
2424
- Actions에서 새 버전 release 가능
2525
- <https://github.com/deargen/workflows> 참고
26+
5. 편의 기능 CLI로 제공
27+
- `mlproject health`로 환경 설정 확인
28+
- `mlproject version`으로 현재 버전 확인
2629

2730
## 돌려 보기
2831

2932
1. (Optional) `pip3 install --user uv` 해서 pip 대신 `uv pip` 사용하면 더 빠름.
3033
2. `uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements.txt`, `uv pip install -e .`, `bash scripts/install_binaries.sh` 으로 dependencies 및 mlproject 패키지 설치
3134
3. template.env 파일을 .env로 복사한 후 token 등 내용 수정.
32-
4. `python -m mlproject.health` 실행해서 환경 설정이 잘 되었는지 확인.
35+
4. `mlproject health` 실행해서 환경 설정이 잘 되었는지 확인.
3336
5. `python tools/examples/color_logging_main.py` 실행해보기. 로깅 내용은 `data/logs` 폴더 안에 기록됨.
3437
6. `uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements_dev.txt` 으로 pytest 등 개발자용 패키지도 설치가능
3538
7. `pytest` 커맨드로 테스트 실행해보기.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7f40ebd0de285458662c30fa70d757d1edaed74ca7a2a8754b7d20f72301affe requirements.in
1+
f3fa95620b66d1ecfd6ac496cd0269cb5a45a1662e05564dd8e81f94900f1d1d requirements.in

deps/lock/aarch64-apple-darwin/requirements.txt

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements.txt --python-platform aarch64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements.txt --python-platform aarch64-apple-darwin --python-version 3.11
33
ansi2html==1.9.2
44
# via -r requirements.in
55
attrs==23.2.0
@@ -19,6 +19,8 @@ charset-normalizer==3.3.2
1919
# via requests
2020
clearml==1.16.2
2121
# via -r requirements.in
22+
click==8.1.7
23+
# via typer
2224
contourpy==1.2.1
2325
# via matplotlib
2426
cssselect2==0.7.0
@@ -91,11 +93,15 @@ referencing==0.35.1
9193
requests==2.32.3
9294
# via clearml
9395
rich==13.7.1
94-
# via -r requirements.in
96+
# via
97+
# -r requirements.in
98+
# typer
9599
rpds-py==0.18.1
96100
# via
97101
# jsonschema
98102
# referencing
103+
shellingham==1.5.4
104+
# via typer
99105
six==1.16.0
100106
# via
101107
# clearml
@@ -113,6 +119,10 @@ tinycss2==1.3.0
113119
# cssselect2
114120
tqdm==4.66.4
115121
# via -r requirements.in
122+
typer==0.12.5
123+
# via -r requirements.in
124+
typing-extensions==4.12.2
125+
# via typer
116126
urllib3==2.2.2
117127
# via
118128
# clearml

deps/lock/aarch64-apple-darwin/requirements_dev.txt

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements_dev.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements_dev.txt --python-platform aarch64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements_dev.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements_dev.txt --python-platform aarch64-apple-darwin --python-version 3.11
33
ansi2html==1.9.2
44
# via -r requirements.in
55
attrs==23.2.0
@@ -27,6 +27,7 @@ click==8.1.7
2727
# via
2828
# mkdocs
2929
# mkdocstrings
30+
# typer
3031
colorama==0.4.6
3132
# via
3233
# griffe
@@ -214,13 +215,17 @@ requests==2.32.3
214215
# clearml
215216
# mkdocs-material
216217
rich==13.7.1
217-
# via -r requirements.in
218+
# via
219+
# -r requirements.in
220+
# typer
218221
rpds-py==0.18.1
219222
# via
220223
# jsonschema
221224
# referencing
222225
ruff==0.4.5
223226
# via -r requirements_dev.in
227+
shellingham==1.5.4
228+
# via typer
224229
six==1.16.0
225230
# via
226231
# clearml
@@ -236,14 +241,20 @@ tinycss2==1.3.0
236241
# via
237242
# cairosvg
238243
# cssselect2
244+
tomli==2.0.1
245+
# via coverage
239246
tqdm==4.66.4
240247
# via -r requirements.in
248+
typer==0.12.5
249+
# via -r requirements.in
241250
types-pytz==2024.1.0.20240417
242251
# via pandas-stubs
243252
types-seaborn==0.13.2.20240417
244253
# via -r requirements_dev.in
245254
types-tqdm==4.66.0.20240106
246255
# via -r requirements_dev.in
256+
typing-extensions==4.12.2
257+
# via typer
247258
urllib3==2.2.2
248259
# via
249260
# clearml

deps/lock/aarch64-apple-darwin/requirements_docs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements_docs.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements_docs.txt --python-platform aarch64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements_docs.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/aarch64-apple-darwin/requirements_docs.txt --python-platform aarch64-apple-darwin --python-version 3.11
33
babel==2.15.0
44
# via mkdocs-material
55
cairocffi==1.7.1
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7f40ebd0de285458662c30fa70d757d1edaed74ca7a2a8754b7d20f72301affe requirements.in
1+
f3fa95620b66d1ecfd6ac496cd0269cb5a45a1662e05564dd8e81f94900f1d1d requirements.in

deps/lock/x86_64-apple-darwin/requirements.txt

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements.txt --python-platform x86_64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements.txt --python-platform x86_64-apple-darwin --python-version 3.11
33
ansi2html==1.9.2
44
# via -r requirements.in
55
attrs==23.2.0
@@ -19,6 +19,8 @@ charset-normalizer==3.3.2
1919
# via requests
2020
clearml==1.16.2
2121
# via -r requirements.in
22+
click==8.1.7
23+
# via typer
2224
contourpy==1.2.1
2325
# via matplotlib
2426
cssselect2==0.7.0
@@ -91,11 +93,15 @@ referencing==0.35.1
9193
requests==2.32.3
9294
# via clearml
9395
rich==13.7.1
94-
# via -r requirements.in
96+
# via
97+
# -r requirements.in
98+
# typer
9599
rpds-py==0.18.1
96100
# via
97101
# jsonschema
98102
# referencing
103+
shellingham==1.5.4
104+
# via typer
99105
six==1.16.0
100106
# via
101107
# clearml
@@ -113,6 +119,10 @@ tinycss2==1.3.0
113119
# cssselect2
114120
tqdm==4.66.4
115121
# via -r requirements.in
122+
typer==0.12.5
123+
# via -r requirements.in
124+
typing-extensions==4.12.2
125+
# via typer
116126
urllib3==2.2.2
117127
# via
118128
# clearml

deps/lock/x86_64-apple-darwin/requirements_dev.txt

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements_dev.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements_dev.txt --python-platform x86_64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements_dev.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements_dev.txt --python-platform x86_64-apple-darwin --python-version 3.11
33
ansi2html==1.9.2
44
# via -r requirements.in
55
attrs==23.2.0
@@ -27,6 +27,7 @@ click==8.1.7
2727
# via
2828
# mkdocs
2929
# mkdocstrings
30+
# typer
3031
colorama==0.4.6
3132
# via
3233
# griffe
@@ -214,13 +215,17 @@ requests==2.32.3
214215
# clearml
215216
# mkdocs-material
216217
rich==13.7.1
217-
# via -r requirements.in
218+
# via
219+
# -r requirements.in
220+
# typer
218221
rpds-py==0.18.1
219222
# via
220223
# jsonschema
221224
# referencing
222225
ruff==0.4.5
223226
# via -r requirements_dev.in
227+
shellingham==1.5.4
228+
# via typer
224229
six==1.16.0
225230
# via
226231
# clearml
@@ -236,14 +241,20 @@ tinycss2==1.3.0
236241
# via
237242
# cairosvg
238243
# cssselect2
244+
tomli==2.0.1
245+
# via coverage
239246
tqdm==4.66.4
240247
# via -r requirements.in
248+
typer==0.12.5
249+
# via -r requirements.in
241250
types-pytz==2024.1.0.20240417
242251
# via pandas-stubs
243252
types-seaborn==0.13.2.20240417
244253
# via -r requirements_dev.in
245254
types-tqdm==4.66.0.20240106
246255
# via -r requirements_dev.in
256+
typing-extensions==4.12.2
257+
# via typer
247258
urllib3==2.2.2
248259
# via
249260
# clearml

deps/lock/x86_64-apple-darwin/requirements_docs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was autogenerated by uv via the following command:
2-
# uv pip compile requirements_docs.in -o /home/runner/work/python-project-template-2024/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements_docs.txt --python-platform x86_64-apple-darwin --python-version 3.11
2+
# uv pip compile requirements_docs.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-apple-darwin/requirements_docs.txt --python-platform x86_64-apple-darwin --python-version 3.11
33
babel==2.15.0
44
# via mkdocs-material
55
cairocffi==1.7.1
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7f40ebd0de285458662c30fa70d757d1edaed74ca7a2a8754b7d20f72301affe requirements.in
1+
f3fa95620b66d1ecfd6ac496cd0269cb5a45a1662e05564dd8e81f94900f1d1d requirements.in

0 commit comments

Comments
 (0)