Skip to content

Commit d78ae4f

Browse files
kiyoonkiyoon
committed
feat: typer -> cyclopts
1 parent 147e072 commit d78ae4f

14 files changed

+95
-197
lines changed

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ basedpyright,
1616
pytest, doctest, nbval (Jupyter Notebook regression testing),
1717
MkDocs,
1818
[version-pioneer](https://github.com/kiyoon/version-pioneer),
19-
GitHub Actions, conventional commit, changelog, typer CLI, rich logging,,
19+
GitHub Actions, conventional commit, changelog, cyclopts CLI, rich logging,,
2020
hatchling build backend,
2121
...
2222

@@ -50,7 +50,7 @@ uv tool install 'git+https://github.com/deargen/python-project-template-2024'
5050
4. Versioning the project and automatically generating changelog.
5151
- Release new version in Actions (commit changelog and tag, create release)
5252
- Refer to <https://github.com/deargen/workflows>
53-
5. Provide convenience features with CLI (typer)
53+
5. Provide convenience features with CLI (cyclopts)
5454
- `ml-project health` to check environment settings.
5555
- `ml-project --version` to check the current version.
5656

@@ -153,7 +153,7 @@ basedpyright,
153153
pytest, doctest, nbval (Jupyter Notebook regression testing),
154154
MkDocs,
155155
[version-pioneer](https://github.com/kiyoon/version-pioneer),
156-
GitHub Actions, conventional commit, changelog, typer CLI, rich logging,,
156+
GitHub Actions, conventional commit, changelog, cyclopts CLI, rich logging,,
157157
hatchling build backend,
158158

159159
... 등 좋은 것 다 쓰는 파이썬 프로젝트 템플릿입니다.

‎deps/lock/aarch64-apple-darwin/.requirements.in.sha256

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1763ca8d914cd3a965a738deea92337b4b4d86fe55942de08eb52cb600954c86 requirements.in
1+
0eac5e6063fcb35ebc81c67b362ce5718e0770e72422b9bb03c380787569e53d requirements.in

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

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# This file was autogenerated by uv via the following command:
22
# 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.10
3-
click==8.1.7
4-
# via typer
5-
docstring-parser==0.16
3+
attrs==25.1.0
4+
# via cyclopts
5+
cyclopts==3.9.0
66
# via -r requirements.in
7+
docstring-parser==0.16
8+
# via cyclopts
9+
docutils==0.21.2
10+
# via rich-rst
711
markdown-it-py==3.0.0
812
# via rich
913
mdurl==0.1.2
@@ -17,12 +21,11 @@ python-dotenv==1.0.1
1721
rich==13.7.1
1822
# via
1923
# -r requirements.in
20-
# typer
21-
shellingham==1.5.4
22-
# via typer
24+
# cyclopts
25+
# rich-rst
26+
rich-rst==1.3.1
27+
# via cyclopts
2328
tqdm==4.66.4
2429
# via -r requirements.in
25-
typer==0.12.5
26-
# via -r requirements.in
2730
typing-extensions==4.12.2
28-
# via typer
31+
# via cyclopts

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

+11-8
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ asttokens==3.0.0
66
# via stack-data
77
attrs==25.1.0
88
# via
9+
# cyclopts
910
# jsonschema
1011
# referencing
1112
babel==2.15.0
@@ -24,7 +25,6 @@ click==8.1.7
2425
# via
2526
# mkdocs
2627
# mkdocstrings
27-
# typer
2828
colorama==0.4.6
2929
# via
3030
# griffe
@@ -41,14 +41,18 @@ cssselect2==0.7.0
4141
# via cairosvg
4242
cycler==0.12.1
4343
# via matplotlib
44+
cyclopts==3.9.0
45+
# via -r requirements.in
4446
debugpy==1.8.12
4547
# via ipykernel
4648
decorator==5.1.1
4749
# via ipython
4850
defusedxml==0.7.1
4951
# via cairosvg
5052
docstring-parser==0.16
51-
# via -r requirements.in
53+
# via cyclopts
54+
docutils==0.21.2
55+
# via rich-rst
5256
exceptiongroup==1.2.2
5357
# via
5458
# ipython
@@ -269,15 +273,16 @@ requests==2.32.3
269273
rich==13.7.1
270274
# via
271275
# -r requirements.in
272-
# typer
276+
# cyclopts
277+
# rich-rst
278+
rich-rst==1.3.1
279+
# via cyclopts
273280
rpds-py==0.22.3
274281
# via
275282
# jsonschema
276283
# referencing
277284
ruff==0.8.4
278285
# via -r requirements_dev.in
279-
shellingham==1.5.4
280-
# via typer
281286
six==1.16.0
282287
# via python-dateutil
283288
stack-data==0.6.3
@@ -306,8 +311,6 @@ traitlets==5.14.3
306311
# jupyter-core
307312
# matplotlib-inline
308313
# nbformat
309-
typer==0.12.5
310-
# via -r requirements.in
311314
types-pytz==2024.1.0.20240417
312315
# via pandas-stubs
313316
types-seaborn==0.13.2.20240417
@@ -316,9 +319,9 @@ types-tqdm==4.66.0.20240106
316319
# via -r requirements_dev.in
317320
typing-extensions==4.12.2
318321
# via
322+
# cyclopts
319323
# ipython
320324
# referencing
321-
# typer
322325
urllib3==2.2.2
323326
# via requests
324327
version-pioneer==0.0.7

‎deps/lock/x86_64-apple-darwin/.requirements.in.sha256

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1763ca8d914cd3a965a738deea92337b4b4d86fe55942de08eb52cb600954c86 requirements.in
1+
0eac5e6063fcb35ebc81c67b362ce5718e0770e72422b9bb03c380787569e53d requirements.in

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

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# This file was autogenerated by uv via the following command:
22
# 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.10
3-
click==8.1.7
4-
# via typer
5-
docstring-parser==0.16
3+
attrs==25.1.0
4+
# via cyclopts
5+
cyclopts==3.9.0
66
# via -r requirements.in
7+
docstring-parser==0.16
8+
# via cyclopts
9+
docutils==0.21.2
10+
# via rich-rst
711
markdown-it-py==3.0.0
812
# via rich
913
mdurl==0.1.2
@@ -17,12 +21,11 @@ python-dotenv==1.0.1
1721
rich==13.7.1
1822
# via
1923
# -r requirements.in
20-
# typer
21-
shellingham==1.5.4
22-
# via typer
24+
# cyclopts
25+
# rich-rst
26+
rich-rst==1.3.1
27+
# via cyclopts
2328
tqdm==4.66.4
2429
# via -r requirements.in
25-
typer==0.12.5
26-
# via -r requirements.in
2730
typing-extensions==4.12.2
28-
# via typer
31+
# via cyclopts

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

+11-8
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ asttokens==3.0.0
66
# via stack-data
77
attrs==25.1.0
88
# via
9+
# cyclopts
910
# jsonschema
1011
# referencing
1112
babel==2.15.0
@@ -24,7 +25,6 @@ click==8.1.7
2425
# via
2526
# mkdocs
2627
# mkdocstrings
27-
# typer
2828
colorama==0.4.6
2929
# via
3030
# griffe
@@ -41,14 +41,18 @@ cssselect2==0.7.0
4141
# via cairosvg
4242
cycler==0.12.1
4343
# via matplotlib
44+
cyclopts==3.9.0
45+
# via -r requirements.in
4446
debugpy==1.8.12
4547
# via ipykernel
4648
decorator==5.1.1
4749
# via ipython
4850
defusedxml==0.7.1
4951
# via cairosvg
5052
docstring-parser==0.16
51-
# via -r requirements.in
53+
# via cyclopts
54+
docutils==0.21.2
55+
# via rich-rst
5256
exceptiongroup==1.2.2
5357
# via
5458
# ipython
@@ -269,15 +273,16 @@ requests==2.32.3
269273
rich==13.7.1
270274
# via
271275
# -r requirements.in
272-
# typer
276+
# cyclopts
277+
# rich-rst
278+
rich-rst==1.3.1
279+
# via cyclopts
273280
rpds-py==0.22.3
274281
# via
275282
# jsonschema
276283
# referencing
277284
ruff==0.8.4
278285
# via -r requirements_dev.in
279-
shellingham==1.5.4
280-
# via typer
281286
six==1.16.0
282287
# via python-dateutil
283288
stack-data==0.6.3
@@ -306,8 +311,6 @@ traitlets==5.14.3
306311
# jupyter-core
307312
# matplotlib-inline
308313
# nbformat
309-
typer==0.12.5
310-
# via -r requirements.in
311314
types-pytz==2024.1.0.20240417
312315
# via pandas-stubs
313316
types-seaborn==0.13.2.20240417
@@ -316,9 +319,9 @@ types-tqdm==4.66.0.20240106
316319
# via -r requirements_dev.in
317320
typing-extensions==4.12.2
318321
# via
322+
# cyclopts
319323
# ipython
320324
# referencing
321-
# typer
322325
urllib3==2.2.2
323326
# via requests
324327
version-pioneer==0.0.7

‎deps/lock/x86_64-manylinux_2_28/.requirements.in.sha256

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1763ca8d914cd3a965a738deea92337b4b4d86fe55942de08eb52cb600954c86 requirements.in
1+
0eac5e6063fcb35ebc81c67b362ce5718e0770e72422b9bb03c380787569e53d requirements.in

‎deps/lock/x86_64-manylinux_2_28/requirements.txt

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# This file was autogenerated by uv via the following command:
22
# uv pip compile requirements.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-manylinux_2_28/requirements.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10
3-
click==8.1.7
4-
# via typer
5-
docstring-parser==0.16
3+
attrs==25.1.0
4+
# via cyclopts
5+
cyclopts==3.9.0
66
# via -r requirements.in
7+
docstring-parser==0.16
8+
# via cyclopts
9+
docutils==0.21.2
10+
# via rich-rst
711
markdown-it-py==3.0.0
812
# via rich
913
mdurl==0.1.2
@@ -17,12 +21,11 @@ python-dotenv==1.0.1
1721
rich==13.7.1
1822
# via
1923
# -r requirements.in
20-
# typer
21-
shellingham==1.5.4
22-
# via typer
24+
# cyclopts
25+
# rich-rst
26+
rich-rst==1.3.1
27+
# via cyclopts
2328
tqdm==4.66.4
2429
# via -r requirements.in
25-
typer==0.12.5
26-
# via -r requirements.in
2730
typing-extensions==4.12.2
28-
# via typer
31+
# via cyclopts

‎deps/lock/x86_64-manylinux_2_28/requirements_dev.txt

+11-8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ asttokens==3.0.0
44
# via stack-data
55
attrs==25.1.0
66
# via
7+
# cyclopts
78
# jsonschema
89
# referencing
910
babel==2.15.0
@@ -22,7 +23,6 @@ click==8.1.7
2223
# via
2324
# mkdocs
2425
# mkdocstrings
25-
# typer
2626
colorama==0.4.6
2727
# via
2828
# griffe
@@ -39,14 +39,18 @@ cssselect2==0.7.0
3939
# via cairosvg
4040
cycler==0.12.1
4141
# via matplotlib
42+
cyclopts==3.9.0
43+
# via -r requirements.in
4244
debugpy==1.8.12
4345
# via ipykernel
4446
decorator==5.1.1
4547
# via ipython
4648
defusedxml==0.7.1
4749
# via cairosvg
4850
docstring-parser==0.16
49-
# via -r requirements.in
51+
# via cyclopts
52+
docutils==0.21.2
53+
# via rich-rst
5054
exceptiongroup==1.2.2
5155
# via
5256
# ipython
@@ -267,15 +271,16 @@ requests==2.32.3
267271
rich==13.7.1
268272
# via
269273
# -r requirements.in
270-
# typer
274+
# cyclopts
275+
# rich-rst
276+
rich-rst==1.3.1
277+
# via cyclopts
271278
rpds-py==0.22.3
272279
# via
273280
# jsonschema
274281
# referencing
275282
ruff==0.8.4
276283
# via -r requirements_dev.in
277-
shellingham==1.5.4
278-
# via typer
279284
six==1.16.0
280285
# via python-dateutil
281286
stack-data==0.6.3
@@ -304,8 +309,6 @@ traitlets==5.14.3
304309
# jupyter-core
305310
# matplotlib-inline
306311
# nbformat
307-
typer==0.12.5
308-
# via -r requirements.in
309312
types-pytz==2024.1.0.20240417
310313
# via pandas-stubs
311314
types-seaborn==0.13.2.20240417
@@ -314,9 +317,9 @@ types-tqdm==4.66.0.20240106
314317
# via -r requirements_dev.in
315318
typing-extensions==4.12.2
316319
# via
320+
# cyclopts
317321
# ipython
318322
# referencing
319-
# typer
320323
urllib3==2.2.2
321324
# via requests
322325
version-pioneer==0.0.7

‎deps/requirements.in

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
rich>=13.0.0
22
tqdm>=4.0.0
3-
typer>=0.12.4 # python 3.11 `SomeType | None` support
4-
docstring_parser # typer help text from_docstring
3+
cyclopts>=3.9.0
54
python-dotenv
65
platformdirs

‎src/ml_project/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
__version__ = get_version_dict()["version"]
5050
APP_NAME = __name__
5151
APP_NAME_UPPER = APP_NAME.upper()
52-
PACKAGE_NAME = APP_NAME.replace("_", "-")
52+
PACKAGE_NAME = APP_NAME.replace("_", "-") if __package__ is None else __package__
5353

5454
# ┌──────────────────────────────────────────────────────────────────────────────────┐
5555
# │ directory definitions and environment variables / dotenv │

0 commit comments

Comments
 (0)