feat: dynamic dependencies (no more declaring inside pyproject.toml)

Author: kiyoon

README.md

@@ -52,31 +52,34 @@
 📂 scripts/                 # 프로젝트와 직접 관련 X, but 프로젝트 관리를 위해 필요
 
 📂 deps/
-│ # 직접 수정 X
+│ # 직접 수정 X. scripts/compile_requirements.sh 실행시 생성됨.
 │ 🛡️ .requirements.in.sha256
 │ 🛡️ .requirements_dev.in.sha256
 │ 🛡️ .requirements_docs.in.sha256
 │
-│ # 혹시 모를 dependency 오류를 방지하기 위해 현재 사용중인 static version 작성. `pyproject.toml`과 얼추 비슷해야함.
+│ # 프로그램 사용자에게 필요한 dependencies.
 │ 🖊️ requirements.in
-│ # 프로그램 사용자가 아닌 개발자에게 필요한 dependencies. `pyproject.toml`과 얼추 비슷해야함.
+│ # 프로그램 사용자가 아닌 개발자에게 필요한 dependencies.
 │ 🖊️ requirements_dev.in
 │ # mkdocs로 문서 생성할때 필요한 프로그램들
 │ 🖊️ requirements_docs.in
+│ # NOTE: in 파일은 lock 파일이 아닌 패키지 dependency이므로 전부 dynamic version으로 작성해야함.
 │
 │ # 직접 수정 X. in 파일에서 생성됨
 │ 🔒 requirements.txt
 │ 🔒 requirements_dev.txt
 └ 🔒 requirements_docs.txt
 
-⚙️ pyproject.toml            # 파이썬 프로젝트 일반 정보. `pip install -e .`으로 설치할 때 설치되는 dependencies는 물론, ruff등 외부 툴의 설정도 포함.
+⚙️ pyproject.toml            # 파이썬 프로젝트 통합 정보. ruff등 외부 툴의 설정도 포함.
 ```
 
 ## 템플릿 사용하기
 
 1. `src/mlproject` 폴더 이름 원하는 걸로 바꾸기 (`import mlproject` 할 때 이름)
 2. `pyproject.toml`에 바꿔야하는 부분 주석 되어있음. 바꿔 쓰기
-3. `requirements.txt`에는 fixed version을 적고, `pyproject.toml`의 패키지들은 dynamic version으로 하기
+3. `requirements*.txt`에는 fixed version을 적고, `requirements*.in`의 패키지들은 dynamic version으로 하기
+    - `pyproject.toml`에는 `requirements*.in` 파일을 참조하도록 설정되어 있음.
+    - 패키지의 dependency는 dynamic하지만 연구팀 내에서는 fixed version (`requirements*.txt`)를 사용하는 것이 좋음.
 4. `README.md`에 있는 badge들 URL (python-project-template-2024 -> 새 주소) 바꾸어 주어야 제대로 테스트 결과가 뜸.
 5. `.github` 폴더 복사한 뒤,
     - GitLab에 document 호스팅용 새 repo를 만듦 (예: mlproject-docs)

deps/.requirements.in.sha256

@@ -1 +1 @@
-148dea70d02d47970fdcde796de144da7b2c57dfa28598eb8732f613f7e3a3c1  requirements_dev.in
+b60225662f46bea871b4eda78e074a85e9b20c40fb6b6eb5688eb98552c7b3cf  requirements_dev.in

deps/.requirements_dev.in.sha256

@@ -1 +1 @@
-2498fc535b1cab961140005b83cf43affe9b4ec815db4fee94698948f744f4c9  requirements_docs.in
+b60225662f46bea871b4eda78e074a85e9b20c40fb6b6eb5688eb98552c7b3cf  requirements_dev.in

deps/.requirements_docs.in.sha256

@@ -1,5 +1,5 @@
-rich==13.7.0
-tqdm==4.66.2
+rich>=13.0.0
+tqdm>=4.0.0
 pillow
 matplotlib
 numpy

deps/requirements.in

@@ -1,4 +1,4 @@
-# This file was autogenerated by uv v0.1.5 via the following command:
+# This file was autogenerated by uv via the following command:
 #    uv pip compile requirements.in -o requirements.txt
 ansi2html==1.9.1
 attrs==23.2.0
@@ -36,7 +36,7 @@ jsonschema-specifications==2023.12.1
     # via jsonschema
 kiwisolver==1.4.5
     # via matplotlib
-markdown-it-py==3.0.0
+markdown-it-py==2.2.0
     # via rich
 matplotlib==3.8.3
 mdurl==0.1.2

deps/requirements.txt

@@ -1,4 +1,5 @@
 -r requirements.in
+-r requirements_docs.in
 ruff==0.2.2
 pytest==8.0.1
 pytest-cov==4.1.0

deps/requirements_dev.in

@@ -1,21 +1,32 @@
-# This file was autogenerated by uv v0.1.5 via the following command:
+# This file was autogenerated by uv via the following command:
 #    uv pip compile requirements_dev.in -o requirements_dev.txt
 ansi2html==1.9.1
 attrs==23.2.0
     # via
     #   clearml
     #   jsonschema
     #   referencing
+babel==2.14.0
+    # via mkdocs-material
 cairocffi==1.6.1
     # via cairosvg
 cairosvg==2.7.1
+    # via mkdocs-material
 certifi==2024.2.2
     # via requests
 cffi==1.16.0
     # via cairocffi
 charset-normalizer==3.3.2
     # via requests
 clearml==1.14.4
+click==8.1.7
+    # via
+    #   mkdocs
+    #   mkdocstrings
+colorama==0.4.6
+    # via
+    #   griffe
+    #   mkdocs-material
 contourpy==1.2.0
     # via matplotlib
 coverage==7.4.3
@@ -30,22 +41,71 @@ fonttools==4.49.0
     # via matplotlib
 furl==2.1.3
     # via clearml
+ghp-import==2.1.0
+    # via mkdocs
+griffe==0.41.0
+    # via mkdocstrings-python
 idna==3.6
     # via requests
+importlib-metadata==7.0.1
+    # via mike
+importlib-resources==6.1.2
+    # via mike
 iniconfig==2.0.0
     # via pytest
+jinja2==3.1.3
+    # via
+    #   mike
+    #   mkdocs
+    #   mkdocs-material
+    #   mkdocstrings
 jsonschema==4.21.1
     # via clearml
 jsonschema-specifications==2023.12.1
     # via jsonschema
 kiwisolver==1.4.5
     # via matplotlib
+markdown==3.5.2
+    # via
+    #   mkdocs
+    #   mkdocs-autorefs
+    #   mkdocs-material
+    #   mkdocstrings
+    #   pymdown-extensions
 markdown-it-py==3.0.0
     # via rich
+markupsafe==2.1.5
+    # via
+    #   jinja2
+    #   mkdocs
+    #   mkdocstrings
 matplotlib==3.8.3
     # via types-seaborn
 mdurl==0.1.2
     # via markdown-it-py
+mergedeep==1.3.4
+    # via mkdocs
+mike==2.0.0
+mkdocs==1.5.3
+    # via
+    #   mike
+    #   mkdocs-autorefs
+    #   mkdocs-coverage
+    #   mkdocs-gen-files
+    #   mkdocs-literate-nav
+    #   mkdocs-material
+    #   mkdocstrings
+mkdocs-autorefs==0.5.0
+    # via mkdocstrings
+mkdocs-coverage==1.0.0
+mkdocs-gen-files==0.5.0
+mkdocs-literate-nav==0.6.1
+mkdocs-material==9.5.3
+mkdocs-material-extensions==1.3.1
+    # via mkdocs-material
+mkdocstrings==0.24.0
+    # via mkdocstrings-python
+mkdocstrings-python==1.8.0
 numpy==1.26.4
     # via
     #   clearml
@@ -58,47 +118,76 @@ orderedmultidict==1.0.1
 packaging==23.2
     # via
     #   matplotlib
+    #   mkdocs
     #   pytest
+paginate==0.5.6
+    # via mkdocs-material
 pandas-stubs==2.2.0.240218
     # via types-seaborn
 pathlib2==2.3.7.post1
     # via clearml
-pillow==10.2.0
+pathspec==0.12.1
+    # via mkdocs
+pillow==9.5.0
     # via
     #   cairosvg
     #   clearml
     #   matplotlib
+    #   mkdocs-material
+platformdirs==4.2.0
+    # via
+    #   mkdocs
+    #   mkdocstrings
 pluggy==1.4.0
     # via pytest
 psutil==5.9.8
     # via clearml
 pycparser==2.21
     # via cffi
 pygments==2.17.2
-    # via rich
+    # via
+    #   mkdocs-material
+    #   rich
 pyjwt==2.8.0
     # via clearml
+pymdown-extensions==10.7
+    # via
+    #   mkdocs-material
+    #   mkdocstrings
 pyparsing==3.1.1
     # via
     #   clearml
     #   matplotlib
+    #   mike
 pytest==8.0.1
     # via pytest-cov
 pytest-cov==4.1.0
 python-dateutil==2.8.2
     # via
     #   clearml
+    #   ghp-import
     #   matplotlib
 python-dotenv==1.0.1
 pyyaml==6.0.1
-    # via clearml
+    # via
+    #   clearml
+    #   mike
+    #   mkdocs
+    #   pymdown-extensions
+    #   pyyaml-env-tag
+pyyaml-env-tag==0.1
+    # via mkdocs
 referencing==0.33.0
     # via
     #   clearml
     #   jsonschema
     #   jsonschema-specifications
+regex==2023.12.25
+    # via mkdocs-material
 requests==2.31.0
-    # via clearml
+    # via
+    #   clearml
+    #   mkdocs-material
 rich==13.7.0
 rpds-py==0.18.0
     # via
@@ -128,7 +217,13 @@ urllib3==2.2.1
     # via
     #   clearml
     #   requests
+verspec==0.1.0
+    # via mike
+watchdog==4.0.0
+    # via mkdocs
 webencodings==0.5.1
     # via
     #   cssselect2
     #   tinycss2
+zipp==3.17.0
+    # via importlib-metadata