diff --git a/.github/workflows/apply-pip-compile.yml b/.github/workflows/apply-pip-compile.yml index bb38cf8..25323b4 100644 --- a/.github/workflows/apply-pip-compile.yml +++ b/.github/workflows/apply-pip-compile.yml @@ -13,4 +13,4 @@ jobs: pyproject-toml-file: pyproject.toml requirements-in-dir: deps requirements-out-dir: deps/lock - python-platforms: x86_64-manylinux_2_28,aarch64-apple-darwin,x86_64-apple-darwin,x86_64-pc-windows-msvc + python-platforms: x86_64-manylinux_2_28,aarch64-apple-darwin,x86_64-apple-darwin diff --git a/.github/workflows/check-pip-compile.yml b/.github/workflows/check-pip-compile.yml index 78d5f6d..5e510f6 100644 --- a/.github/workflows/check-pip-compile.yml +++ b/.github/workflows/check-pip-compile.yml @@ -22,4 +22,4 @@ jobs: pyproject-toml-file: pyproject.toml requirements-in-dir: deps requirements-out-dir: deps/lock - python-platforms: x86_64-manylinux_2_28,aarch64-apple-darwin,x86_64-apple-darwin,x86_64-pc-windows-msvc + python-platforms: x86_64-manylinux_2_28,aarch64-apple-darwin,x86_64-apple-darwin diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..32eff92 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Deargen Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index 64a0fcf..476cf7a 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,11 @@ -# python-project-template-2024 +# biotest | | | |--|--| -|[![Ruff](https://img.shields.io/badge/Ruff-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/ruff) |[![Actions status](https://github.com/deargen/python-project-template-2024/workflows/Style%20checking/badge.svg)](https://github.com/deargen/python-project-template-2024/actions)| -| [![Ruff](https://img.shields.io/badge/Ruff-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/ruff) | [![Actions status](https://github.com/deargen/python-project-template-2024/workflows/Linting/badge.svg)](https://github.com/deargen/python-project-template-2024/actions) | -| [![pytest](https://img.shields.io/badge/pytest-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/pytest-dev/pytest) [![doctest](https://img.shields.io/badge/doctest-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://docs.python.org/3/library/doctest.html) | [![Actions status](https://github.com/deargen/python-project-template-2024/workflows/Tests/badge.svg)](https://github.com/deargen/python-project-template-2024/actions) | -| [![uv](https://img.shields.io/badge/uv-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/uv) | [![Actions status](https://github.com/deargen/python-project-template-2024/workflows/Check%20pip%20compile%20sync/badge.svg)](https://github.com/deargen/python-project-template-2024/actions) | -|[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)|[![Actions status](https://github.com/deargen/python-project-template-2024/workflows/Deploy%20MkDocs%20on%20latest%20commit/badge.svg)](https://github.com/deargen/python-project-template-2024/actions)| +|[![Ruff](https://img.shields.io/badge/Ruff-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/ruff) |[![Actions status](https://github.com/deargen/biotest/workflows/Style%20checking/badge.svg)](https://github.com/deargen/biotest/actions)| +| [![Ruff](https://img.shields.io/badge/Ruff-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/ruff) | [![Actions status](https://github.com/deargen/biotest/workflows/Linting/badge.svg)](https://github.com/deargen/biotest/actions) | +| [![pytest](https://img.shields.io/badge/pytest-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/pytest-dev/pytest) [![doctest](https://img.shields.io/badge/doctest-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://docs.python.org/3/library/doctest.html) | [![Actions status](https://github.com/deargen/biotest/workflows/Tests/badge.svg)](https://github.com/deargen/biotest/actions) | +| [![uv](https://img.shields.io/badge/uv-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://github.com/astral-sh/uv) | [![Actions status](https://github.com/deargen/biotest/workflows/Check%20pip%20compile%20sync/badge.svg)](https://github.com/deargen/biotest/actions) | +|[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)|[![Actions status](https://github.com/deargen/biotest/workflows/Deploy%20MkDocs%20on%20latest%20commit/badge.svg)](https://github.com/deargen/biotest/actions)| -새 파이썬 프로젝트 시작할 때 사용하실 템플릿입니다. - -**주요 기능** - -1. Github Actions로 ruff formatter, ruff linter, pytest (unit test) 통과 여부 확인 - - Actions에서 포매팅 적용 가능 -2. GitHub Actions로 uv pip-compile 적용 여부 확인 (`deps/requirements.in`의 dynamic version을 `deps/lock` 안에 lock file로 변환) - - Actions에서 lock file compile 가능 -3. MkDocs 이용해 자동 document 생성 - - Public repo는 GitHub Pages 이용 - - Private repo는 GitLab Pages 이용 -4. 프로젝트 versioning하고 changelog 자동 생성. - - Actions에서 새 버전 release 가능 - - 참고 -5. 편의 기능 CLI로 제공 - - `ml-project health`로 환경 설정 확인 - - `ml-project --version`으로 현재 버전 확인 - -## 돌려 보기 - -1. (Optional) `pip3 install --user uv` 해서 pip 대신 `uv pip` 사용하면 더 빠름. -2. `uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements.txt`, `uv pip install -e .` 으로 dependencies 및 ml-project 패키지 설치 -3. template.env 파일을 .env로 복사한 후 token 등 내용 수정. -4. `ml-project health` 실행해서 환경 설정이 잘 되었는지 확인. -5. `python tools/examples/color_logging_main.py` 실행해보기. 로깅 내용은 `data/logs` 폴더 안에 기록됨. - - `ML_PROJECT_LOG_LEVEL=WARNING python tools/examples/color_logging_main.py`라고 실행하면 출력 내용중 INFO 인것이 빠지고 출력됨. -7. `uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements_dev.txt` 으로 pytest 등 개발자용 패키지도 설치가능 -8. `pytest` 커맨드로 테스트 실행해보기. - - doctest는 Actions에서 자동으로 실행됨. -9. `import ml_project; print(ml_project.__version__)` 해보면 `0.1.0+4.g75bbed7.dirty` 이런식으로 나옴. - - 0.1.0 버전 이후 4개의 커밋이란 뜻. 그리고 커밋되지 않은 수정사항이 있는 상태이면 dirty버전임. - -## 파일 설명 - -```sh -📂 .vscode/ -└ 📄 extensions.json # VSCode에서 사용하는 확장 프로그램 목록. - -📂 .github/ -│ 📂 ISSUE_TEMPLATE/ -└ 📂 workflows/ # 깃헙 액션 자동화 배포 파이프라인 - └ 📄 *.yml - -📂 src/ -└ 📂 ml_project/ # `import ml_project`해서 사용하는 함수나 클래스 등 정의하는 곳 - │ 🐍 __init__.py - │ 🐍 _version.py # git tag로 버전 정보를 읽는 versioneer 파일 (수정X) - └ 🐍 ... - -📂 tools/ # import 하지 않고 바로 실행 가능한 파일들. (예: train.py) - -📂 tests/ # `pytest` 실행시 실행되는 함수들 - -📂 scripts/ # 프로젝트와 직접 관련 X, but 프로젝트 관리를 위해 필요 -│ # MkDocs reference 페이지 생성할때 모듈 찾는 스크립트. -│ # 수동으로 제외하고 싶은 모듈 있으면 수정도 가능! -└ 🐍 gen_ref_nav.py - -📂 deps/ -│ # 직접 수정 X. .github/workflows/apply-pip-compile.yml 실행시 생성됨. -│ 🛡️ .requirements.in.sha256 -│ 🛡️ .requirements_dev.in.sha256 -│ 🛡️ .requirements_docs.in.sha256 -│ -│ # 프로그램 사용자에게 필요한 dependencies. -│ 🖊️ requirements.in -│ # 프로그램 사용자가 아닌 개발자에게 필요한 dependencies. -│ 🖊️ requirements_dev.in -│ # mkdocs로 문서 생성할때 필요한 프로그램들 -│ 🖊️ requirements_docs.in -│ # NOTE: in 파일은 lock 파일이 아닌 패키지 dependency이므로 전부 dynamic version으로 작성해야함. -│ -│ # 직접 수정 X. in 파일에서 생성됨 -└ 📂 lock/ - │ 🔒 requirements.txt - │ 🔒 requirements_dev.txt - └ 🔒 requirements_docs.txt - -⚙️ pyproject.toml # 파이썬 프로젝트 통합 정보. ruff등 외부 툴의 설정도 포함. -``` - -## 템플릿 사용하기 - -프로젝트 이름 바꾸기 위해 `./replace_project_name.sh` 내용을 수정 후 실행합니다. 스크립트에서 아래 내용을 해결해줍니다. - -1. `src/ml_project` 폴더 이름 원하는 걸로 바꾸기 (`import ml_project` 할 때 이름) -2. `pyproject.toml`에 바꿔야하는 부분 주석 되어있음. 바꿔 쓰기 -3. `README.md`에 있는 badge들 URL (python-project-template-2024 -> 새 주소) 바꾸어 주어야 제대로 테스트 결과가 뜸. - -❗ 해당 스크립트는 단순 치환이기에 두번 작동하지 않습니다. 한 번 쓰고 지우세요. - -그 외 알아두면 좋은 것들: - -1. `deps/requirements*.in`을 수정하면 `deps/lock` 폴더에 lock 파일이 생성됨. (Actions) -2. GitLab에 document 호스팅용 새 repo 만들기 (예: ml-project-docs) - - [GitLab Pages 설정](https://deargen-ai.gitlab.io/python-project-template-docs/latest/mkdocs/gitlab_pages) 문서 참고. - - docs, deploy 할 때 필요한 gitlab 주소와 토큰은 Github 프로젝트 설정에서 Environment secrets / variable을 바꾸어야 함. - - 오픈소스의 경우 github page를 이용하도록 `.github/workflows/deploy.yml` 및 `.github/workflows/deploy-mkdocs-on-latest.yml` 파일에서 gitlab 관련 parameter 제거. -3. `setup.py`는 그대로 두면 됨 -4. 테스트를 작성하지 않은 경우, `tests/` 폴더 안의 파일 전부 삭제하면 GitHub Actions에서 테스트 통과됨. -5. ⭐ VSCode에 [Python Tools](https://deargen-ai.gitlab.io/python-project-template-docs/latest/python_tools/formatters) 내용 전부 (formatter, linter, LSP 등) 적용하기. -6. `docs/CHANGELOG.md` 는 맨 위 문단 빼고 수정내용 다 삭제. diff --git a/deps/lock/aarch64-apple-darwin/requirements.txt b/deps/lock/aarch64-apple-darwin/requirements.txt index 2b37eaf..934108e 100644 --- a/deps/lock/aarch64-apple-darwin/requirements.txt +++ b/deps/lock/aarch64-apple-darwin/requirements.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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 +# uv pip compile requirements.in -o /Users/kiyoon/project/biotest/deps/lock/aarch64-apple-darwin/requirements.txt --python-platform aarch64-apple-darwin --python-version 3.10 click==8.1.7 # via typer markdown-it-py==3.0.0 diff --git a/deps/lock/aarch64-apple-darwin/requirements_dev.txt b/deps/lock/aarch64-apple-darwin/requirements_dev.txt index 8548cf5..d89c71a 100644 --- a/deps/lock/aarch64-apple-darwin/requirements_dev.txt +++ b/deps/lock/aarch64-apple-darwin/requirements_dev.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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.10 +# uv pip compile requirements_dev.in -o /Users/kiyoon/project/biotest/deps/lock/aarch64-apple-darwin/requirements_dev.txt --python-platform aarch64-apple-darwin --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/aarch64-apple-darwin/requirements_docs.txt b/deps/lock/aarch64-apple-darwin/requirements_docs.txt index 642cb31..0d442bf 100644 --- a/deps/lock/aarch64-apple-darwin/requirements_docs.txt +++ b/deps/lock/aarch64-apple-darwin/requirements_docs.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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.10 +# uv pip compile requirements_docs.in -o /Users/kiyoon/project/biotest/deps/lock/aarch64-apple-darwin/requirements_docs.txt --python-platform aarch64-apple-darwin --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/x86_64-apple-darwin/requirements.txt b/deps/lock/x86_64-apple-darwin/requirements.txt index c7c3e88..dab28ba 100644 --- a/deps/lock/x86_64-apple-darwin/requirements.txt +++ b/deps/lock/x86_64-apple-darwin/requirements.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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 +# uv pip compile requirements.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-apple-darwin/requirements.txt --python-platform x86_64-apple-darwin --python-version 3.10 click==8.1.7 # via typer markdown-it-py==3.0.0 diff --git a/deps/lock/x86_64-apple-darwin/requirements_dev.txt b/deps/lock/x86_64-apple-darwin/requirements_dev.txt index 7dc8e2a..0b727aa 100644 --- a/deps/lock/x86_64-apple-darwin/requirements_dev.txt +++ b/deps/lock/x86_64-apple-darwin/requirements_dev.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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.10 +# uv pip compile requirements_dev.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-apple-darwin/requirements_dev.txt --python-platform x86_64-apple-darwin --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/x86_64-apple-darwin/requirements_docs.txt b/deps/lock/x86_64-apple-darwin/requirements_docs.txt index 81a77df..c198626 100644 --- a/deps/lock/x86_64-apple-darwin/requirements_docs.txt +++ b/deps/lock/x86_64-apple-darwin/requirements_docs.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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.10 +# uv pip compile requirements_docs.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-apple-darwin/requirements_docs.txt --python-platform x86_64-apple-darwin --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/x86_64-manylinux_2_28/requirements.txt b/deps/lock/x86_64-manylinux_2_28/requirements.txt index 1ea7f60..12eaa10 100644 --- a/deps/lock/x86_64-manylinux_2_28/requirements.txt +++ b/deps/lock/x86_64-manylinux_2_28/requirements.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# 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 +# uv pip compile requirements.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-manylinux_2_28/requirements.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10 click==8.1.7 # via typer markdown-it-py==3.0.0 diff --git a/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt b/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt index 6b17cca..9927f69 100644 --- a/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt +++ b/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# uv pip compile requirements_dev.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10 +# uv pip compile requirements_dev.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-manylinux_2_28/requirements_dev.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt b/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt index 8fec513..ec02044 100644 --- a/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt +++ b/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt @@ -1,5 +1,5 @@ # This file was autogenerated by uv via the following command: -# uv pip compile requirements_docs.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10 +# uv pip compile requirements_docs.in -o /Users/kiyoon/project/biotest/deps/lock/x86_64-manylinux_2_28/requirements_docs.txt --python-platform x86_64-manylinux_2_28 --python-version 3.10 babel==2.15.0 # via mkdocs-material cairocffi==1.7.1 diff --git a/deps/lock/x86_64-pc-windows-msvc/.requirements.in.sha256 b/deps/lock/x86_64-pc-windows-msvc/.requirements.in.sha256 deleted file mode 100644 index 0074abb..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/.requirements.in.sha256 +++ /dev/null @@ -1 +0,0 @@ -eca034df8b46b7bb7a617c6f6a7ab5b825b3198a9edd8d73ab32f96053be69ec requirements.in diff --git a/deps/lock/x86_64-pc-windows-msvc/.requirements_dev.in.sha256 b/deps/lock/x86_64-pc-windows-msvc/.requirements_dev.in.sha256 deleted file mode 100644 index 6947503..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/.requirements_dev.in.sha256 +++ /dev/null @@ -1 +0,0 @@ -273b726ef11dbc739ee87fe778717bb6f5d71c04ac125b87eabba2e906d9129f requirements_dev.in diff --git a/deps/lock/x86_64-pc-windows-msvc/.requirements_docs.in.sha256 b/deps/lock/x86_64-pc-windows-msvc/.requirements_docs.in.sha256 deleted file mode 100644 index 0fb0f7c..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/.requirements_docs.in.sha256 +++ /dev/null @@ -1 +0,0 @@ -32ae49b0d0279ac2f04747fe5ebad436369d1846dbdbf9aad67e50042331c8eb requirements_docs.in diff --git a/deps/lock/x86_64-pc-windows-msvc/requirements.txt b/deps/lock/x86_64-pc-windows-msvc/requirements.txt deleted file mode 100644 index c180a4c..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/requirements.txt +++ /dev/null @@ -1,28 +0,0 @@ -# This file was autogenerated by uv via the following command: -# uv pip compile requirements.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-pc-windows-msvc/requirements.txt --python-platform x86_64-pc-windows-msvc --python-version 3.10 -click==8.1.7 - # via typer -colorama==0.4.6 - # via - # click - # tqdm -markdown-it-py==3.0.0 - # via rich -mdurl==0.1.2 - # via markdown-it-py -pygments==2.18.0 - # via rich -python-dotenv==1.0.1 - # via -r requirements.in -rich==13.7.1 - # via - # -r requirements.in - # typer -shellingham==1.5.4 - # via typer -tqdm==4.66.4 - # via -r requirements.in -typer==0.12.5 - # via -r requirements.in -typing-extensions==4.12.2 - # via typer diff --git a/deps/lock/x86_64-pc-windows-msvc/requirements_dev.txt b/deps/lock/x86_64-pc-windows-msvc/requirements_dev.txt deleted file mode 100644 index 202e195..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/requirements_dev.txt +++ /dev/null @@ -1,232 +0,0 @@ -# This file was autogenerated by uv via the following command: -# uv pip compile requirements_dev.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-pc-windows-msvc/requirements_dev.txt --python-platform x86_64-pc-windows-msvc --python-version 3.10 -babel==2.15.0 - # via mkdocs-material -cairocffi==1.7.1 - # via cairosvg -cairosvg==2.7.1 - # via mkdocs-material -certifi==2024.6.2 - # via requests -cffi==1.16.0 - # via cairocffi -charset-normalizer==3.3.2 - # via requests -click==8.1.7 - # via - # mkdocs - # mkdocstrings - # typer -colorama==0.4.6 - # via - # click - # griffe - # mkdocs - # mkdocs-material - # pytest - # tqdm -contourpy==1.2.1 - # via matplotlib -coverage==7.5.4 - # via pytest-cov -cssselect2==0.7.0 - # via cairosvg -cycler==0.12.1 - # via matplotlib -defusedxml==0.7.1 - # via cairosvg -exceptiongroup==1.2.2 - # via pytest -fonttools==4.53.0 - # via matplotlib -ghp-import==2.1.0 - # via mkdocs -griffe==1.4.1 - # via mkdocstrings-python -idna==3.7 - # via requests -importlib-metadata==8.0.0 - # via mike -importlib-resources==6.4.0 - # via mike -iniconfig==2.0.0 - # via pytest -jinja2==3.1.4 - # via - # mike - # mkdocs - # mkdocs-material - # mkdocstrings -kiwisolver==1.4.5 - # via matplotlib -markdown==3.6 - # via - # mkdocs - # mkdocs-autorefs - # mkdocs-material - # mkdocstrings - # pymdown-extensions -markdown-it-py==3.0.0 - # via rich -markupsafe==2.1.5 - # via - # jinja2 - # mkdocs - # mkdocs-autorefs - # mkdocstrings -matplotlib==3.9.0 - # via types-seaborn -mdurl==0.1.2 - # via markdown-it-py -mergedeep==1.3.4 - # via - # mkdocs - # mkdocs-get-deps -mike==2.1.3 - # via -r requirements_docs.in -mkdocs==1.6.1 - # via - # -r requirements_docs.in - # mike - # mkdocs-autorefs - # mkdocs-coverage - # mkdocs-gen-files - # mkdocs-literate-nav - # mkdocs-material - # mkdocstrings -mkdocs-autorefs==1.2.0 - # via - # -r requirements_docs.in - # mkdocstrings - # mkdocstrings-python -mkdocs-coverage==1.1.0 - # via -r requirements_docs.in -mkdocs-gen-files==0.5.0 - # via -r requirements_docs.in -mkdocs-get-deps==0.2.0 - # via mkdocs -mkdocs-literate-nav==0.6.1 - # via -r requirements_docs.in -mkdocs-material==9.5.40 - # via -r requirements_docs.in -mkdocs-material-extensions==1.3.1 - # via - # -r requirements_docs.in - # mkdocs-material -mkdocstrings==0.26.2 - # via - # -r requirements_docs.in - # mkdocstrings-python -mkdocstrings-python==1.12.0 - # via -r requirements_docs.in -numpy==2.0.0 - # via - # contourpy - # matplotlib - # pandas-stubs - # types-seaborn -packaging==24.1 - # via - # matplotlib - # mkdocs - # pytest -paginate==0.5.6 - # via mkdocs-material -pandas-stubs==2.2.2.240603 - # via types-seaborn -pathspec==0.12.1 - # via mkdocs -pillow==10.4.0 - # via - # cairosvg - # matplotlib - # mkdocs-material -platformdirs==4.2.2 - # via - # mkdocs-get-deps - # mkdocstrings -pluggy==1.5.0 - # via pytest -pycparser==2.22 - # via cffi -pygments==2.18.0 - # via - # mkdocs-material - # rich -pymdown-extensions==10.8.1 - # via - # mkdocs-material - # mkdocstrings -pyparsing==3.1.2 - # via - # matplotlib - # mike -pytest==8.0.1 - # via - # -r requirements_dev.in - # pytest-cov -pytest-cov==4.1.0 - # via -r requirements_dev.in -python-dateutil==2.9.0.post0 - # via - # ghp-import - # matplotlib -python-dotenv==1.0.1 - # via -r requirements.in -pyyaml==6.0.1 - # via - # mike - # mkdocs - # mkdocs-get-deps - # pymdown-extensions - # pyyaml-env-tag -pyyaml-env-tag==0.1 - # via - # mike - # mkdocs -regex==2024.5.15 - # via mkdocs-material -requests==2.32.3 - # via mkdocs-material -rich==13.7.1 - # via - # -r requirements.in - # typer -ruff==0.6.9 - # via -r requirements_dev.in -shellingham==1.5.4 - # via typer -six==1.16.0 - # via python-dateutil -tinycss2==1.3.0 - # via - # cairosvg - # cssselect2 -tomli==2.0.1 - # via - # coverage - # pytest -tqdm==4.66.4 - # via -r requirements.in -typer==0.12.5 - # via -r requirements.in -types-pytz==2024.1.0.20240417 - # via pandas-stubs -types-seaborn==0.13.2.20240417 - # via -r requirements_dev.in -types-tqdm==4.66.0.20240106 - # via -r requirements_dev.in -typing-extensions==4.12.2 - # via typer -urllib3==2.2.2 - # via requests -verspec==0.1.0 - # via mike -watchdog==4.0.1 - # via mkdocs -webencodings==0.5.1 - # via - # cssselect2 - # tinycss2 -zipp==3.19.2 - # via importlib-metadata diff --git a/deps/lock/x86_64-pc-windows-msvc/requirements_docs.txt b/deps/lock/x86_64-pc-windows-msvc/requirements_docs.txt deleted file mode 100644 index 75b970b..0000000 --- a/deps/lock/x86_64-pc-windows-msvc/requirements_docs.txt +++ /dev/null @@ -1,157 +0,0 @@ -# This file was autogenerated by uv via the following command: -# uv pip compile requirements_docs.in -o /Users/kiyoon/project/python-project-template-2024/deps/lock/x86_64-pc-windows-msvc/requirements_docs.txt --python-platform x86_64-pc-windows-msvc --python-version 3.10 -babel==2.15.0 - # via mkdocs-material -cairocffi==1.7.1 - # via cairosvg -cairosvg==2.7.1 - # via mkdocs-material -certifi==2024.6.2 - # via requests -cffi==1.16.0 - # via cairocffi -charset-normalizer==3.3.2 - # via requests -click==8.1.7 - # via - # mkdocs - # mkdocstrings -colorama==0.4.6 - # via - # click - # griffe - # mkdocs - # mkdocs-material -cssselect2==0.7.0 - # via cairosvg -defusedxml==0.7.1 - # via cairosvg -ghp-import==2.1.0 - # via mkdocs -griffe==1.4.1 - # via mkdocstrings-python -idna==3.7 - # via requests -importlib-metadata==8.0.0 - # via mike -importlib-resources==6.4.0 - # via mike -jinja2==3.1.4 - # via - # mike - # mkdocs - # mkdocs-material - # mkdocstrings -markdown==3.6 - # via - # mkdocs - # mkdocs-autorefs - # mkdocs-material - # mkdocstrings - # pymdown-extensions -markupsafe==2.1.5 - # via - # jinja2 - # mkdocs - # mkdocs-autorefs - # mkdocstrings -mergedeep==1.3.4 - # via - # mkdocs - # mkdocs-get-deps -mike==2.1.3 - # via -r requirements_docs.in -mkdocs==1.6.1 - # via - # -r requirements_docs.in - # mike - # mkdocs-autorefs - # mkdocs-coverage - # mkdocs-gen-files - # mkdocs-literate-nav - # mkdocs-material - # mkdocstrings -mkdocs-autorefs==1.2.0 - # via - # -r requirements_docs.in - # mkdocstrings - # mkdocstrings-python -mkdocs-coverage==1.1.0 - # via -r requirements_docs.in -mkdocs-gen-files==0.5.0 - # via -r requirements_docs.in -mkdocs-get-deps==0.2.0 - # via mkdocs -mkdocs-literate-nav==0.6.1 - # via -r requirements_docs.in -mkdocs-material==9.5.40 - # via -r requirements_docs.in -mkdocs-material-extensions==1.3.1 - # via - # -r requirements_docs.in - # mkdocs-material -mkdocstrings==0.26.2 - # via - # -r requirements_docs.in - # mkdocstrings-python -mkdocstrings-python==1.12.0 - # via -r requirements_docs.in -packaging==24.1 - # via mkdocs -paginate==0.5.6 - # via mkdocs-material -pathspec==0.12.1 - # via mkdocs -pillow==10.4.0 - # via - # cairosvg - # mkdocs-material -platformdirs==4.2.2 - # via - # mkdocs-get-deps - # mkdocstrings -pycparser==2.22 - # via cffi -pygments==2.18.0 - # via mkdocs-material -pymdown-extensions==10.8.1 - # via - # mkdocs-material - # mkdocstrings -pyparsing==3.1.2 - # via mike -python-dateutil==2.9.0.post0 - # via ghp-import -pyyaml==6.0.1 - # via - # mike - # mkdocs - # mkdocs-get-deps - # pymdown-extensions - # pyyaml-env-tag -pyyaml-env-tag==0.1 - # via - # mike - # mkdocs -regex==2024.5.15 - # via mkdocs-material -requests==2.32.3 - # via mkdocs-material -six==1.16.0 - # via python-dateutil -tinycss2==1.3.0 - # via - # cairosvg - # cssselect2 -urllib3==2.2.2 - # via requests -verspec==0.1.0 - # via mike -watchdog==4.0.1 - # via mkdocs -webencodings==0.5.1 - # via - # cssselect2 - # tinycss2 -zipp==3.19.2 - # via importlib-metadata diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 67d49a7..60eddac 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -7,187 +7,187 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [v0.2.5] - 2024-10-14 ### :boom: BREAKING CHANGES -- due to [`0ee9ddb`](https://github.com/deargen/python-project-template-2024/commit/0ee9ddb5093e671ec077a5fc00ae5f68ec744ce6) - easier gitlab page setup guide (but defaults to master branch *(commit by [@kiyoon](https://github.com/kiyoon))*: +- due to [`0ee9ddb`](https://github.com/deargen/biotest/commit/0ee9ddb5093e671ec077a5fc00ae5f68ec744ce6) - easier gitlab page setup guide (but defaults to master branch *(commit by [@kiyoon](https://github.com/kiyoon))*: easier gitlab page setup guide (but defaults to master branch ### :sparkles: New Features -- [`0ee9ddb`](https://github.com/deargen/python-project-template-2024/commit/0ee9ddb5093e671ec077a5fc00ae5f68ec744ce6) - easier gitlab page setup guide (but defaults to master branch *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`0ee9ddb`](https://github.com/deargen/biotest/commit/0ee9ddb5093e671ec077a5fc00ae5f68ec744ce6) - easier gitlab page setup guide (but defaults to master branch *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`872bbf9`](https://github.com/deargen/python-project-template-2024/commit/872bbf9023fea5701980b8daef4767fbd97664df) - **replace-name**: mac compatible sed *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`3f0aae4`](https://github.com/deargen/python-project-template-2024/commit/3f0aae42ece6eaedaa661ba202a1ee3586945eaf) - **ci**: check mkdocs *(PR [#27](https://github.com/deargen/python-project-template-2024/pull/27) by [@kiyoon](https://github.com/kiyoon))* -- [`e3a4041`](https://github.com/deargen/python-project-template-2024/commit/e3a40419987e9b3b7b4398c3c70dfe2efc25775c) - **replace_project_name.sh**: sed issue with mac *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`872bbf9`](https://github.com/deargen/biotest/commit/872bbf9023fea5701980b8daef4767fbd97664df) - **replace-name**: mac compatible sed *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`3f0aae4`](https://github.com/deargen/biotest/commit/3f0aae42ece6eaedaa661ba202a1ee3586945eaf) - **ci**: check mkdocs *(PR [#27](https://github.com/deargen/biotest/pull/27) by [@kiyoon](https://github.com/kiyoon))* +- [`e3a4041`](https://github.com/deargen/biotest/commit/e3a40419987e9b3b7b4398c3c70dfe2efc25775c) - **replace_project_name.sh**: sed issue with mac *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.2.4] - 2024-10-10 ### :sparkles: New Features -- [`b6360ab`](https://github.com/deargen/python-project-template-2024/commit/b6360ab906197ca9fe59c5478b3528b474d9b8a7) - **ci**: add exclude-types input to deploy.yml, fix(ci): check-docs.yml *(PR [#26](https://github.com/deargen/python-project-template-2024/pull/26) by [@kiyoon](https://github.com/kiyoon))* +- [`b6360ab`](https://github.com/deargen/biotest/commit/b6360ab906197ca9fe59c5478b3528b474d9b8a7) - **ci**: add exclude-types input to deploy.yml, fix(ci): check-docs.yml *(PR [#26](https://github.com/deargen/biotest/pull/26) by [@kiyoon](https://github.com/kiyoon))* ## [v0.2.3] - 2024-10-05 ### :sparkles: New Features -- [`2261a27`](https://github.com/deargen/python-project-template-2024/commit/2261a27b084e7f06947d6f5d8454fbccc89b4803) - micromamba cache better key *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`2261a27`](https://github.com/deargen/biotest/commit/2261a27b084e7f06947d6f5d8454fbccc89b4803) - micromamba cache better key *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`bebe843`](https://github.com/deargen/python-project-template-2024/commit/bebe843bd6fc714142ff1c92d6c7ebcc67bdac7f) - **config**: undefined variable *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`becff68`](https://github.com/deargen/python-project-template-2024/commit/becff68b9080c65b27f85e98a0a786c3e3bddf75) - relax pylint max statements *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`580b4ee`](https://github.com/deargen/python-project-template-2024/commit/580b4eee572bbc1a30a9bd9be03a8a205c65e6f6) - **ci**: ubuntu-24.04 *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`54f0cae`](https://github.com/deargen/python-project-template-2024/commit/54f0cae043b77fd95c7eb06f1035dcfb70a2a9b1) - **ci**: deploy dry run *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`bebe843`](https://github.com/deargen/biotest/commit/bebe843bd6fc714142ff1c92d6c7ebcc67bdac7f) - **config**: undefined variable *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`becff68`](https://github.com/deargen/biotest/commit/becff68b9080c65b27f85e98a0a786c3e3bddf75) - relax pylint max statements *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`580b4ee`](https://github.com/deargen/biotest/commit/580b4eee572bbc1a30a9bd9be03a8a205c65e6f6) - **ci**: ubuntu-24.04 *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`54f0cae`](https://github.com/deargen/biotest/commit/54f0cae043b77fd95c7eb06f1035dcfb70a2a9b1) - **ci**: deploy dry run *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.2.2] - 2024-09-26 ### :sparkles: New Features -- [`d0f1d71`](https://github.com/deargen/python-project-template-2024/commit/d0f1d7167626b9f723cff19da251af322abd1806) - replace string script to use template instantly *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`5d07c12`](https://github.com/deargen/python-project-template-2024/commit/5d07c12e76ca8615288c77638fb3b524eb76c38a) - log console theme *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`e4d2b12`](https://github.com/deargen/python-project-template-2024/commit/e4d2b124d95052828d50179396a32b40fad3f347) - success level color *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`6837b01`](https://github.com/deargen/python-project-template-2024/commit/6837b014076dcbaaf570f4430d647c07e4b572e5) - **ruff**: more lint rules *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`63db4d0`](https://github.com/deargen/python-project-template-2024/commit/63db4d0f44b14fe895e7b53c8dbf9e9ea0a973f9) - better pylint tolerance *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`13cc21d`](https://github.com/deargen/python-project-template-2024/commit/13cc21d28ae3de5cb5d0dc20d0da938d2f4c61ef) - **ruff**: remove ARG lint *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`60ae13a`](https://github.com/deargen/python-project-template-2024/commit/60ae13a21c12266ee77ea95eeb619ad873e0a6c1) - **ci**: micromamba *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`d0f1d71`](https://github.com/deargen/biotest/commit/d0f1d7167626b9f723cff19da251af322abd1806) - replace string script to use template instantly *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`5d07c12`](https://github.com/deargen/biotest/commit/5d07c12e76ca8615288c77638fb3b524eb76c38a) - log console theme *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`e4d2b12`](https://github.com/deargen/biotest/commit/e4d2b124d95052828d50179396a32b40fad3f347) - success level color *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`6837b01`](https://github.com/deargen/biotest/commit/6837b014076dcbaaf570f4430d647c07e4b572e5) - **ruff**: more lint rules *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`63db4d0`](https://github.com/deargen/biotest/commit/63db4d0f44b14fe895e7b53c8dbf9e9ea0a973f9) - better pylint tolerance *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`13cc21d`](https://github.com/deargen/biotest/commit/13cc21d28ae3de5cb5d0dc20d0da938d2f4c61ef) - **ruff**: remove ARG lint *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`60ae13a`](https://github.com/deargen/biotest/commit/60ae13a21c12266ee77ea95eeb619ad873e0a6c1) - **ci**: micromamba *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`008df63`](https://github.com/deargen/python-project-template-2024/commit/008df630c357578b8c651507405e47841e44cc0a) - change module name with script *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`5e03af9`](https://github.com/deargen/python-project-template-2024/commit/5e03af98111d2e884f690cc449a8f4018060ca88) - rename module actually *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`008df63`](https://github.com/deargen/biotest/commit/008df630c357578b8c651507405e47841e44cc0a) - change module name with script *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`5e03af9`](https://github.com/deargen/biotest/commit/5e03af98111d2e884f690cc449a8f4018060ca88) - rename module actually *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.2.1] - 2024-09-08 ### :boom: BREAKING CHANGES -- due to [`3674e0a`](https://github.com/deargen/python-project-template-2024/commit/3674e0a52b3d37f0a065fdc3c9d6f051eb5910c6) - remove slack *(PR [#25](https://github.com/deargen/python-project-template-2024/pull/25) by [@kiyoon](https://github.com/kiyoon))*: +- due to [`3674e0a`](https://github.com/deargen/biotest/commit/3674e0a52b3d37f0a065fdc3c9d6f051eb5910c6) - remove slack *(PR [#25](https://github.com/deargen/biotest/pull/25) by [@kiyoon](https://github.com/kiyoon))*: remove slack (#25) ### :sparkles: New Features -- [`3f623d8`](https://github.com/deargen/python-project-template-2024/commit/3f623d86cdff079a7727ad5f4289122d568cbdd2) - mkdocs sort source order and ignore some modules in API reference *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`d19eaa1`](https://github.com/deargen/python-project-template-2024/commit/d19eaa122edf7aed9faa0bb8fded999da0b5b0d5) - typer cli *(PR [#24](https://github.com/deargen/python-project-template-2024/pull/24) by [@kiyoon](https://github.com/kiyoon))* +- [`3f623d8`](https://github.com/deargen/biotest/commit/3f623d86cdff079a7727ad5f4289122d568cbdd2) - mkdocs sort source order and ignore some modules in API reference *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`d19eaa1`](https://github.com/deargen/biotest/commit/d19eaa122edf7aed9faa0bb8fded999da0b5b0d5) - typer cli *(PR [#24](https://github.com/deargen/biotest/pull/24) by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`2890b02`](https://github.com/deargen/python-project-template-2024/commit/2890b02ea698b298fea354616b48760a6e83563d) - enable some pyright diagnostics *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`7cc5642`](https://github.com/deargen/python-project-template-2024/commit/7cc56420aaa9cce11424c381b06305b89141ce14) - change unknown linux to manylinux *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`5d098dc`](https://github.com/deargen/python-project-template-2024/commit/5d098dca7d95dfcaff290f6e979a52336a114516) - support more platform than Linux for basedpyright *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`2bb1cf3`](https://github.com/deargen/python-project-template-2024/commit/2bb1cf3cd841a6a81503b431de72c6d2f737fba0) - stub file in mkdocstrings *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`2890b02`](https://github.com/deargen/biotest/commit/2890b02ea698b298fea354616b48760a6e83563d) - enable some pyright diagnostics *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7cc5642`](https://github.com/deargen/biotest/commit/7cc56420aaa9cce11424c381b06305b89141ce14) - change unknown linux to manylinux *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`5d098dc`](https://github.com/deargen/biotest/commit/5d098dca7d95dfcaff290f6e979a52336a114516) - support more platform than Linux for basedpyright *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`2bb1cf3`](https://github.com/deargen/biotest/commit/2bb1cf3cd841a6a81503b431de72c6d2f737fba0) - stub file in mkdocstrings *(commit by [@kiyoon](https://github.com/kiyoon))* ### :recycle: Refactors -- [`3674e0a`](https://github.com/deargen/python-project-template-2024/commit/3674e0a52b3d37f0a065fdc3c9d6f051eb5910c6) - remove slack *(PR [#25](https://github.com/deargen/python-project-template-2024/pull/25) by [@kiyoon](https://github.com/kiyoon))* +- [`3674e0a`](https://github.com/deargen/biotest/commit/3674e0a52b3d37f0a065fdc3c9d6f051eb5910c6) - remove slack *(PR [#25](https://github.com/deargen/biotest/pull/25) by [@kiyoon](https://github.com/kiyoon))* ## [v0.2.0] - 2024-07-02 ### :sparkles: New Features -- [`6892dcc`](https://github.com/deargen/python-project-template-2024/commit/6892dcc2763fd96d9d0b86d691132ab0c02ca0cd) - reusable workflows *(PR [#23](https://github.com/deargen/python-project-template-2024/pull/23) by [@kiyoon](https://github.com/kiyoon))* +- [`6892dcc`](https://github.com/deargen/biotest/commit/6892dcc2763fd96d9d0b86d691132ab0c02ca0cd) - reusable workflows *(PR [#23](https://github.com/deargen/biotest/pull/23) by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.5] - 2024-06-28 ### :sparkles: New Features -- [`929fb46`](https://github.com/deargen/python-project-template-2024/commit/929fb464bd66f910fa59eaceec6e0d4ded84faef) - health check, install binaries, font etc. *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`fab2e06`](https://github.com/deargen/python-project-template-2024/commit/fab2e06f8b5601aa6b8c37cf30e0a3b4bfddf20a) - vscode extensions recommendations *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`3687e2f`](https://github.com/deargen/python-project-template-2024/commit/3687e2f7982a4e8d2b1e6b19c66e55d255733d24) - mac separate dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`7d22258`](https://github.com/deargen/python-project-template-2024/commit/7d22258e44be06fd9890d5fa0409185740ef70c2) - mac dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`0390e7a`](https://github.com/deargen/python-project-template-2024/commit/0390e7ae975414fda4e01097d2c67fece62eab8b) - gh action annotation for ruff *(PR [#21](https://github.com/deargen/python-project-template-2024/pull/21) by [@kiyoon](https://github.com/kiyoon))* -- [`8a20166`](https://github.com/deargen/python-project-template-2024/commit/8a20166f22efb02f221d6a89ed2fbec8119c5e62) - check docs compiling *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`dd09beb`](https://github.com/deargen/python-project-template-2024/commit/dd09beb28ef02e8fc0084127a4ab0d5c58ca7f55) - dry-run changelog generation *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`09672e0`](https://github.com/deargen/python-project-template-2024/commit/09672e03fa0114ea600069377bf22cd70a3c924a) - get_python_version.py without toml dependency, compile reqs with *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`c3fc757`](https://github.com/deargen/python-project-template-2024/commit/c3fc7570ffc16cf55aa3696f323257a6034b3886) - deploy dry run completely separate job *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`929fb46`](https://github.com/deargen/biotest/commit/929fb464bd66f910fa59eaceec6e0d4ded84faef) - health check, install binaries, font etc. *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`fab2e06`](https://github.com/deargen/biotest/commit/fab2e06f8b5601aa6b8c37cf30e0a3b4bfddf20a) - vscode extensions recommendations *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`3687e2f`](https://github.com/deargen/biotest/commit/3687e2f7982a4e8d2b1e6b19c66e55d255733d24) - mac separate dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7d22258`](https://github.com/deargen/biotest/commit/7d22258e44be06fd9890d5fa0409185740ef70c2) - mac dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`0390e7a`](https://github.com/deargen/biotest/commit/0390e7ae975414fda4e01097d2c67fece62eab8b) - gh action annotation for ruff *(PR [#21](https://github.com/deargen/biotest/pull/21) by [@kiyoon](https://github.com/kiyoon))* +- [`8a20166`](https://github.com/deargen/biotest/commit/8a20166f22efb02f221d6a89ed2fbec8119c5e62) - check docs compiling *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`dd09beb`](https://github.com/deargen/biotest/commit/dd09beb28ef02e8fc0084127a4ab0d5c58ca7f55) - dry-run changelog generation *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`09672e0`](https://github.com/deargen/biotest/commit/09672e03fa0114ea600069377bf22cd70a3c924a) - get_python_version.py without toml dependency, compile reqs with *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`c3fc757`](https://github.com/deargen/biotest/commit/c3fc7570ffc16cf55aa3696f323257a6034b3886) - deploy dry run completely separate job *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`22f16d5`](https://github.com/deargen/python-project-template-2024/commit/22f16d574be015cdd568487866e44b3d0573aec8) - **slack**: send_only *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`4bd8ae8`](https://github.com/deargen/python-project-template-2024/commit/4bd8ae894d327ee832e8a0825828509427e6fec5) - slack token default being wrong token *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`8a63607`](https://github.com/deargen/python-project-template-2024/commit/8a63607dad7902248c5643c6251cfcb213bccf2a) - dry-run deploy leaving version tag *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`f9adbf7`](https://github.com/deargen/python-project-template-2024/commit/f9adbf71768066b28721822ca73b7b5c03c3e45e) - maybe fix echo evaluating backticks *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`be3b895`](https://github.com/deargen/python-project-template-2024/commit/be3b895f24220658d2d1ba4a08131f11edde1e18) - maybe fix wrong echo *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`cd6f2ee`](https://github.com/deargen/python-project-template-2024/commit/cd6f2ee55699fd70849d528ec022b0f8a5ffd0f4) - ci deploy always dry-run *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`d4d9766`](https://github.com/deargen/python-project-template-2024/commit/d4d9766337f786134c72ec2397dc0244ab80f447) - get python version *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`7bee54b`](https://github.com/deargen/python-project-template-2024/commit/7bee54b3af0af91836ddd515a681887f72c3580d) - use min python version instead of max *(PR [#22](https://github.com/deargen/python-project-template-2024/pull/22) by [@kiyoon](https://github.com/kiyoon))* +- [`22f16d5`](https://github.com/deargen/biotest/commit/22f16d574be015cdd568487866e44b3d0573aec8) - **slack**: send_only *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`4bd8ae8`](https://github.com/deargen/biotest/commit/4bd8ae894d327ee832e8a0825828509427e6fec5) - slack token default being wrong token *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`8a63607`](https://github.com/deargen/biotest/commit/8a63607dad7902248c5643c6251cfcb213bccf2a) - dry-run deploy leaving version tag *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`f9adbf7`](https://github.com/deargen/biotest/commit/f9adbf71768066b28721822ca73b7b5c03c3e45e) - maybe fix echo evaluating backticks *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`be3b895`](https://github.com/deargen/biotest/commit/be3b895f24220658d2d1ba4a08131f11edde1e18) - maybe fix wrong echo *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`cd6f2ee`](https://github.com/deargen/biotest/commit/cd6f2ee55699fd70849d528ec022b0f8a5ffd0f4) - ci deploy always dry-run *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`d4d9766`](https://github.com/deargen/biotest/commit/d4d9766337f786134c72ec2397dc0244ab80f447) - get python version *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7bee54b`](https://github.com/deargen/biotest/commit/7bee54b3af0af91836ddd515a681887f72c3580d) - use min python version instead of max *(PR [#22](https://github.com/deargen/biotest/pull/22) by [@kiyoon](https://github.com/kiyoon))* ### :wrench: Chores -- [`6ba5a0a`](https://github.com/deargen/python-project-template-2024/commit/6ba5a0ab16eb6d98e19feac3b4f5741c104a2686) - ignore ruff SIM108 *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`6ba5a0a`](https://github.com/deargen/biotest/commit/6ba5a0ab16eb6d98e19feac3b4f5741c104a2686) - ignore ruff SIM108 *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.4] - 2024-03-08 ### :sparkles: New Features -- [`fa319d1`](https://github.com/deargen/python-project-template-2024/commit/fa319d1efca76f72b08a0a0013da810f426942a8) - dependabot *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`d13437a`](https://github.com/deargen/python-project-template-2024/commit/d13437a7ae32f6924d77482093e914a752718a77) - doctest, test cache *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`5c64a64`](https://github.com/deargen/python-project-template-2024/commit/5c64a644036682c193da3379640893def147929d) - diagram with mermaid *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`87a5e82`](https://github.com/deargen/python-project-template-2024/commit/87a5e820b9d1afa15ea5c8fd2a3ad0e8d01c0dcc) - config system with env vars *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`828d38b`](https://github.com/deargen/python-project-template-2024/commit/828d38bafa33243221c77105e9a3eca843f74bbd) - use uv pip compile *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`aa79009`](https://github.com/deargen/python-project-template-2024/commit/aa79009b4b0445ecf02d1f2446c973f39fe56885) - slack and health *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`11430d5`](https://github.com/deargen/python-project-template-2024/commit/11430d5f70f2e6afadd700c7f56226a737d4bfaa) - send exception to slack (txt, html, pdf) *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`40fcb05`](https://github.com/deargen/python-project-template-2024/commit/40fcb05a1cc4de783c1ec05a8326075b34a209e4) - dynamic dependencies (no more declaring inside pyproject.toml) *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`fa319d1`](https://github.com/deargen/biotest/commit/fa319d1efca76f72b08a0a0013da810f426942a8) - dependabot *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`d13437a`](https://github.com/deargen/biotest/commit/d13437a7ae32f6924d77482093e914a752718a77) - doctest, test cache *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`5c64a64`](https://github.com/deargen/biotest/commit/5c64a644036682c193da3379640893def147929d) - diagram with mermaid *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`87a5e82`](https://github.com/deargen/biotest/commit/87a5e820b9d1afa15ea5c8fd2a3ad0e8d01c0dcc) - config system with env vars *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`828d38b`](https://github.com/deargen/biotest/commit/828d38bafa33243221c77105e9a3eca843f74bbd) - use uv pip compile *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`aa79009`](https://github.com/deargen/biotest/commit/aa79009b4b0445ecf02d1f2446c973f39fe56885) - slack and health *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`11430d5`](https://github.com/deargen/biotest/commit/11430d5f70f2e6afadd700c7f56226a737d4bfaa) - send exception to slack (txt, html, pdf) *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`40fcb05`](https://github.com/deargen/biotest/commit/40fcb05a1cc4de783c1ec05a8326075b34a209e4) - dynamic dependencies (no more declaring inside pyproject.toml) *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`c65c2aa`](https://github.com/deargen/python-project-template-2024/commit/c65c2aab2685e0f90e904219ebee01570b439c14) - requirements *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`964e190`](https://github.com/deargen/python-project-template-2024/commit/964e1908a2066188c61750ef4e85423bdab8da40) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`4b16c37`](https://github.com/deargen/python-project-template-2024/commit/4b16c37ff1811a2319a2757e78fc6b14edfeb42a) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`270c1b3`](https://github.com/deargen/python-project-template-2024/commit/270c1b3adc305ef4ca1bb27495dd85cba30cd656) - doctest *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`1f4adfe`](https://github.com/deargen/python-project-template-2024/commit/1f4adfee1d9603546357f4840a0efd31a60a6d75) - ppmi -> mlproject *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`8750e67`](https://github.com/deargen/python-project-template-2024/commit/8750e67d73301a594c81fcba8cb5fdf93a4d0178) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`25c6266`](https://github.com/deargen/python-project-template-2024/commit/25c62667c71db2951d953b1bd70bf6d4a9b78e47) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`32a7947`](https://github.com/deargen/python-project-template-2024/commit/32a7947095380c0a0cdb58b473f812ee1614e438) - failing doctest *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`eeb48a0`](https://github.com/deargen/python-project-template-2024/commit/eeb48a0cd9257051efaaa3e7c565b787e189fd0e) - requirements_dev *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`15c58d5`](https://github.com/deargen/python-project-template-2024/commit/15c58d522dba0b233ab5270e94ccb0d854d54ef1) - compile_requirements *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`c65c2aa`](https://github.com/deargen/biotest/commit/c65c2aab2685e0f90e904219ebee01570b439c14) - requirements *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`964e190`](https://github.com/deargen/biotest/commit/964e1908a2066188c61750ef4e85423bdab8da40) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`4b16c37`](https://github.com/deargen/biotest/commit/4b16c37ff1811a2319a2757e78fc6b14edfeb42a) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`270c1b3`](https://github.com/deargen/biotest/commit/270c1b3adc305ef4ca1bb27495dd85cba30cd656) - doctest *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`1f4adfe`](https://github.com/deargen/biotest/commit/1f4adfee1d9603546357f4840a0efd31a60a6d75) - ppmi -> mlproject *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`8750e67`](https://github.com/deargen/biotest/commit/8750e67d73301a594c81fcba8cb5fdf93a4d0178) - docs *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`25c6266`](https://github.com/deargen/biotest/commit/25c62667c71db2951d953b1bd70bf6d4a9b78e47) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`32a7947`](https://github.com/deargen/biotest/commit/32a7947095380c0a0cdb58b473f812ee1614e438) - failing doctest *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`eeb48a0`](https://github.com/deargen/biotest/commit/eeb48a0cd9257051efaaa3e7c565b787e189fd0e) - requirements_dev *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`15c58d5`](https://github.com/deargen/biotest/commit/15c58d522dba0b233ab5270e94ccb0d854d54ef1) - compile_requirements *(commit by [@kiyoon](https://github.com/kiyoon))* ### :zap: Performance Improvements -- [`35a8ec9`](https://github.com/deargen/python-project-template-2024/commit/35a8ec98eb46ed7c5f163182aa7ff90eeb2339f8) - cache doc pip dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`dff52a1`](https://github.com/deargen/python-project-template-2024/commit/dff52a19e5cf374632dc4b1fcdf00b28177f6348) - improve docs action *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`35a8ec9`](https://github.com/deargen/biotest/commit/35a8ec98eb46ed7c5f163182aa7ff90eeb2339f8) - cache doc pip dependencies *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`dff52a1`](https://github.com/deargen/biotest/commit/dff52a19e5cf374632dc4b1fcdf00b28177f6348) - improve docs action *(commit by [@kiyoon](https://github.com/kiyoon))* ### :recycle: Refactors -- [`c269ff8`](https://github.com/deargen/python-project-template-2024/commit/c269ff865813ecdba743de02ed03e0853ff097e8) - remove hard-coded versions from CI *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`9f2a693`](https://github.com/deargen/python-project-template-2024/commit/9f2a6936ac1b58fcc18301f6e25992c03e7a7b23) - ruff version from requirements *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`7d983e7`](https://github.com/deargen/python-project-template-2024/commit/7d983e7d468a390200932835686f9ca3356fe138) - rich print exporting, not only traceback *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`c269ff8`](https://github.com/deargen/biotest/commit/c269ff865813ecdba743de02ed03e0853ff097e8) - remove hard-coded versions from CI *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`9f2a693`](https://github.com/deargen/biotest/commit/9f2a6936ac1b58fcc18301f6e25992c03e7a7b23) - ruff version from requirements *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7d983e7`](https://github.com/deargen/biotest/commit/7d983e7d468a390200932835686f9ca3356fe138) - rich print exporting, not only traceback *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.3] - 2024-01-28 ### :sparkles: New Features -- [`26e3420`](https://github.com/deargen/python-project-template-2024/commit/26e3420d7a7fa0855106056f52f3742e0f8c8981) - **mkdocs**: add __init__.py generator script *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`dac4beb`](https://github.com/deargen/python-project-template-2024/commit/dac4beb0856e9f5156f2d3840021270ae4c60dc5) - logging, more example of docstring *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`afd9514`](https://github.com/deargen/python-project-template-2024/commit/afd95146b7f6f5def19c21a587b57983593b9729) - format on action *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`26e3420`](https://github.com/deargen/biotest/commit/26e3420d7a7fa0855106056f52f3742e0f8c8981) - **mkdocs**: add __init__.py generator script *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`dac4beb`](https://github.com/deargen/biotest/commit/dac4beb0856e9f5156f2d3840021270ae4c60dc5) - logging, more example of docstring *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`afd9514`](https://github.com/deargen/biotest/commit/afd95146b7f6f5def19c21a587b57983593b9729) - format on action *(commit by [@kiyoon](https://github.com/kiyoon))* ### :bug: Bug Fixes -- [`b877fc8`](https://github.com/deargen/python-project-template-2024/commit/b877fc82d755e3b449b8bb99221d968c8f19099a) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`156859a`](https://github.com/deargen/python-project-template-2024/commit/156859acaf77c1e3477efdeeb481652ba3c3bffd) - some ppmi stuff *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`8c18b80`](https://github.com/deargen/python-project-template-2024/commit/8c18b804fbaa8c4e270c1dca13d12e5622f26691) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`b877fc8`](https://github.com/deargen/biotest/commit/b877fc82d755e3b449b8bb99221d968c8f19099a) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`156859a`](https://github.com/deargen/biotest/commit/156859acaf77c1e3477efdeeb481652ba3c3bffd) - some ppmi stuff *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`8c18b80`](https://github.com/deargen/biotest/commit/8c18b804fbaa8c4e270c1dca13d12e5622f26691) - ci *(commit by [@kiyoon](https://github.com/kiyoon))* ### :wrench: Chores -- [`7b4dcf8`](https://github.com/deargen/python-project-template-2024/commit/7b4dcf8f3d954e2a818a1d0c20f510c75035421a) - change url *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7b4dcf8`](https://github.com/deargen/biotest/commit/7b4dcf8f3d954e2a818a1d0c20f510c75035421a) - change url *(commit by [@kiyoon](https://github.com/kiyoon))* ### :flying_saucer: Other Changes -- [`dd2cb1d`](https://github.com/deargen/python-project-template-2024/commit/dd2cb1d68adfe10c1073ea812e5f5b427a326d30) - Merge branch 'master' of ssh://github.com/deargen/python-project-template-2024 *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`21ac2b3`](https://github.com/deargen/python-project-template-2024/commit/21ac2b3aa8fb0d5f7b234eb1ced89f383e7215c4) - Merge branch 'master' of ssh://github.com/deargen/python-project-template-2024 *(commit by [@kiyoon](https://github.com/kiyoon))* -- [`7afc6d4`](https://github.com/deargen/python-project-template-2024/commit/7afc6d4e0d6fef2703f00921f006bf47582ea32b) - Merge branch 'master' of ssh://github.com/deargen/python-project-template-2024 *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`dd2cb1d`](https://github.com/deargen/biotest/commit/dd2cb1d68adfe10c1073ea812e5f5b427a326d30) - Merge branch 'master' of ssh://github.com/deargen/biotest *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`21ac2b3`](https://github.com/deargen/biotest/commit/21ac2b3aa8fb0d5f7b234eb1ced89f383e7215c4) - Merge branch 'master' of ssh://github.com/deargen/biotest *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`7afc6d4`](https://github.com/deargen/biotest/commit/7afc6d4e0d6fef2703f00921f006bf47582ea32b) - Merge branch 'master' of ssh://github.com/deargen/biotest *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.2] - 2024-01-16 ### :wrench: Chores -- [`e4445cf`](https://github.com/deargen/python-project-template-2024/commit/e4445cf9962154a4e8f4df2bbe04b80584dce769) - test new changelog path *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`e4445cf`](https://github.com/deargen/biotest/commit/e4445cf9962154a4e8f4df2bbe04b80584dce769) - test new changelog path *(commit by [@kiyoon](https://github.com/kiyoon))* ### :flying_saucer: Other Changes -- [`e3cb529`](https://github.com/deargen/python-project-template-2024/commit/e3cb529dfbccbacc9a1bc4e6d32a368a9e7bd209) - Merge branch 'master' of ssh://github.com/deargen/python-project-template-2024 *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`e3cb529`](https://github.com/deargen/biotest/commit/e3cb529dfbccbacc9a1bc4e6d32a368a9e7bd209) - Merge branch 'master' of ssh://github.com/deargen/biotest *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.1] - 2024-01-16 ### :wrench: Chores -- [`e375a3b`](https://github.com/deargen/python-project-template-2024/commit/e375a3b0c96c8fc49aa86948f63226a73b11f0de) - move CHANGELOG.md into docs/ *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`e375a3b`](https://github.com/deargen/biotest/commit/e375a3b0c96c8fc49aa86948f63226a73b11f0de) - move CHANGELOG.md into docs/ *(commit by [@kiyoon](https://github.com/kiyoon))* ## [v0.1.0] - 2024-01-16 ### :wrench: Chores -- [`2e302a0`](https://github.com/deargen/python-project-template-2024/commit/2e302a0cb155aa7b11a6d76f99bfff5abb504890) - change URL *(commit by [@kiyoon](https://github.com/kiyoon))* +- [`2e302a0`](https://github.com/deargen/biotest/commit/2e302a0cb155aa7b11a6d76f99bfff5abb504890) - change URL *(commit by [@kiyoon](https://github.com/kiyoon))* -[v0.1.0]: https://github.com/deargen/python-project-template-2024/compare/v0.0.0...v0.1.0 -[v0.1.1]: https://github.com/deargen/python-project-template-2024/compare/v0.1.0...v0.1.1 -[v0.1.2]: https://github.com/deargen/python-project-template-2024/compare/v0.1.1...v0.1.2 -[v0.1.3]: https://github.com/deargen/python-project-template-2024/compare/v0.1.2...v0.1.3 +[v0.1.0]: https://github.com/deargen/biotest/compare/v0.0.0...v0.1.0 +[v0.1.1]: https://github.com/deargen/biotest/compare/v0.1.0...v0.1.1 +[v0.1.2]: https://github.com/deargen/biotest/compare/v0.1.1...v0.1.2 +[v0.1.3]: https://github.com/deargen/biotest/compare/v0.1.2...v0.1.3 -[v0.1.3]: https://github.com/deargen/python-project-template-2024/compare/v0.1.2...v0.1.3 +[v0.1.3]: https://github.com/deargen/biotest/compare/v0.1.2...v0.1.3 -[v0.1.3]: https://github.com/deargen/python-project-template-2024/compare/v0.1.2...v0.1.3 -[v0.1.4]: https://github.com/deargen/python-project-template-2024/compare/v0.1.3...v0.1.4 -[v0.1.5]: https://github.com/deargen/python-project-template-2024/compare/v0.1.4...v0.1.5 -[v0.2.0]: https://github.com/deargen/python-project-template-2024/compare/v0.1.6...v0.2.0 -[v0.2.1]: https://github.com/deargen/python-project-template-2024/compare/v0.2.0...v0.2.1 -[v0.2.2]: https://github.com/deargen/python-project-template-2024/compare/v0.2.1...v0.2.2 -[v0.2.3]: https://github.com/deargen/python-project-template-2024/compare/v0.2.2...v0.2.3 -[v0.2.4]: https://github.com/deargen/python-project-template-2024/compare/v0.2.3...v0.2.4 -[v0.2.5]: https://github.com/deargen/python-project-template-2024/compare/v0.2.4...v0.2.5 +[v0.1.3]: https://github.com/deargen/biotest/compare/v0.1.2...v0.1.3 +[v0.1.4]: https://github.com/deargen/biotest/compare/v0.1.3...v0.1.4 +[v0.1.5]: https://github.com/deargen/biotest/compare/v0.1.4...v0.1.5 +[v0.2.0]: https://github.com/deargen/biotest/compare/v0.1.6...v0.2.0 +[v0.2.1]: https://github.com/deargen/biotest/compare/v0.2.0...v0.2.1 +[v0.2.2]: https://github.com/deargen/biotest/compare/v0.2.1...v0.2.2 +[v0.2.3]: https://github.com/deargen/biotest/compare/v0.2.2...v0.2.3 +[v0.2.4]: https://github.com/deargen/biotest/compare/v0.2.3...v0.2.4 +[v0.2.5]: https://github.com/deargen/biotest/compare/v0.2.4...v0.2.5 diff --git a/docs/mkdocs/mkdocstrings.md b/docs/mkdocs/mkdocstrings.md index cd49ca6..f695f3c 100644 --- a/docs/mkdocs/mkdocstrings.md +++ b/docs/mkdocs/mkdocstrings.md @@ -3,14 +3,14 @@ ## 설명하고 싶은 모듈/함수/클래스가 있다면 다음과 같이 마크다운 파일에 적으면 됩니다. ```md -::: ml_project.two_numbers.TwoNumbers +::: biotest.two_numbers.TwoNumbers options: show_root_heading: true ``` 출력은 아래와 같습니다. -::: ml_project.two_numbers.TwoNumbers +::: biotest.two_numbers.TwoNumbers options: show_root_heading: true @@ -19,7 +19,7 @@ ## Submodule까지 전부 포함하고 싶으시면 다음과 같이 작성합니다. ```md -::: ml_project +::: biotest options: show_root_heading: true show_submodules: true @@ -27,7 +27,7 @@ 출력은 아래와 같습니다. -::: ml_project +::: biotest options: show_submodules: true @@ -36,7 +36,7 @@ ## 소스코드만 출력하고 싶으시면 다음과 같이 작성합니다. ```md -::: ml_project.two_numbers.TwoNumbers +::: biotest.two_numbers.TwoNumbers options: show_docstring_attributes: false show_docstring_functions: false @@ -58,7 +58,7 @@ 출력은 아래와 같습니다. -::: ml_project.two_numbers.TwoNumbers +::: biotest.two_numbers.TwoNumbers options: show_docstring_attributes: false show_docstring_functions: false @@ -84,7 +84,7 @@ ## 목차에서 Heading level을 바꾸고 싶다면 마크다운처럼 #을 쓰시면 됩니다. ```md -### ::: ml_project.two_numbers.TwoNumbers +### ::: biotest.two_numbers.TwoNumbers options: show_docstring_description: false show_docstring_examples: false diff --git a/docs/python/configuration.md b/docs/python/configuration.md index eebfee2..12144f7 100644 --- a/docs/python/configuration.md +++ b/docs/python/configuration.md @@ -75,7 +75,7 @@ main을 보면, 몇 가지 parameter를 argparse에 넣으면 그에 맞게 conf 사용법을 먼저 보여드리자면, -### ::: ml_project.utils.config.ExampleConfig +### ::: biotest.utils.config.ExampleConfig options: show_docstring_description: true show_docstring_examples: false @@ -83,7 +83,7 @@ main을 보면, 몇 가지 parameter를 argparse에 넣으면 그에 맞게 conf show_bases: false show_source: true -### ::: ml_project.utils.config.ExampleConfig +### ::: biotest.utils.config.ExampleConfig options: show_docstring_description: false show_docstring_examples: true @@ -92,7 +92,7 @@ main을 보면, 몇 가지 parameter를 argparse에 넣으면 그에 맞게 conf show_source: false BaseConfig 소스코드: -### ::: ml_project.utils.config.BaseConfig +### ::: biotest.utils.config.BaseConfig options: show_docstring_description: false show_docstring_examples: false diff --git a/docs/python/logging.md b/docs/python/logging.md index 3d915fd..cd0cf7e 100644 --- a/docs/python/logging.md +++ b/docs/python/logging.md @@ -40,7 +40,7 @@ rich.traceback.install(show_locals=True) import logging -from ml_project.utils import setup_logging +from biotest.utils import setup_logging logger = logging.getLogger(__name__) @@ -63,7 +63,7 @@ if __name__ == "__main__": 본 template에서는 logging을 쉽게 설정할 수 있는 함수를 제공합니다. -### ::: ml_project.utils.setup_logging +### ::: biotest.utils.setup_logging options: show_root_heading: true diff --git a/docs/python/versioneer.md b/docs/python/versioneer.md index 6855eeb..bf8d843 100644 --- a/docs/python/versioneer.md +++ b/docs/python/versioneer.md @@ -11,9 +11,9 @@ - [**Versioneer**](https://github.com/python-versioneer/python-versioneer): 버전 정보를 git tag에서 읽어와 python project versioning ```python hl_lines="3" -import ml_project +import biotest -print(ml_project.__version__) +print(biotest.__version__) ``` ```title="out" @@ -27,7 +27,7 @@ print(ml_project.__version__) ## 설치 -1. `src/ml_project/__init__.py`, `src/ml_project/_version.py` 가져다 쓰기 +1. `src/biotest/__init__.py`, `src/biotest/_version.py` 가져다 쓰기 2. `pyproject.toml`에 versioneer 관련 섹션 가져다 쓰기 ## 비슷한 툴 diff --git a/docs/python_tools/formatters.md b/docs/python_tools/formatters.md index 75ef714..f63f608 100644 --- a/docs/python_tools/formatters.md +++ b/docs/python_tools/formatters.md @@ -53,7 +53,7 @@ import os from my_other_lib import run import sys - import ml_project + import biotest from third_lib import Widget ``` @@ -67,7 +67,7 @@ from my_other_lib import run from third_lib import Widget - import ml_project + import biotest ``` ### [ruff](https://github.com/astral-sh/ruff): Rust로 구현한 매우 빠른 black, isort (+ flake8 linter까지) diff --git a/docs/python_tools/linter.md b/docs/python_tools/linter.md index e8ad778..7057129 100644 --- a/docs/python_tools/linter.md +++ b/docs/python_tools/linter.md @@ -27,7 +27,7 @@ Linting 결과를 무시하고 싶은 경우: ```toml [tool.ruff] extend-exclude = [ - "src/ml_project/_version.py", # CHANGE + "src/biotest/_version.py", # CHANGE ] [tool.ruff.lint] diff --git a/mkdocs.yml b/mkdocs.yml index db01cab..bec5028 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: Python Project Template -site_url: 'https://deargen-ai.gitlab.io/python-project-template-docs' -repo_url: 'https://github.com/deargen/python-project-template-2024' +site_name: BioTest +site_url: 'https://deargen.github.io/biotest' +repo_url: 'https://github.com/deargen/biotest' copyright: | © 2024 Deargen Inc. watch: [mkdocs.yml, README.md, src/] @@ -94,7 +94,7 @@ plugins: extra: social: - icon: fontawesome/brands/github-alt - link: https://github.com/deargen/python-project-template-2024 + link: https://github.com/deargen/biotest version: provider: mike diff --git a/pyproject.toml b/pyproject.toml index 422436c..6b300b5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,13 +5,13 @@ build-backend = "setuptools.build_meta" [tool.versioneer] VCS = "git" style = "pep440" -versionfile_source = "src/ml_project/_version.py" # CHANGE -versionfile_build = "ml_project/_version.py" # CHANGE +versionfile_source = "src/biotest/_version.py" # CHANGE +versionfile_build = "biotest/_version.py" # CHANGE tag_prefix = "v" -parentdir_prefix = "ml-project-" # CHANGE +parentdir_prefix = "biotest-" # CHANGE [project] -name = "ml-project" # CHANGE +name = "biotest" # CHANGE dynamic = ["version", "dependencies", "optional-dependencies"] description = "Python project template" # OPTIONALLY CHANGE authors = [ @@ -32,10 +32,10 @@ classifiers = [ keywords = ["development", "template"] [project.urls] -"Homepage" = "https://github.com/deargen/python-project-template-2024" # OPTIONALLY CHANGE +"Homepage" = "https://github.com/deargen/biotest" # OPTIONALLY CHANGE [project.scripts] -ml-project = "ml_project.cli:main" +biotest = "biotest.cli:main" [tool.setuptools.dynamic] dependencies = {file = ["deps/requirements.in"]} @@ -44,13 +44,13 @@ dependencies = {file = ["deps/requirements.in"]} where = ["src"] [tool.pytest.ini_options] -addopts = "--cov=ml_project" # CHANGE (name of the importing module name) +addopts = "--cov=biotest" # CHANGE (name of the importing module name) testpaths = ["tests"] [tool.ruff] namespace-packages = ["tools", "scripts"] # for INP rule, suppress on these directories extend-exclude = [ - "src/ml_project/_version.py", # CHANGE + "src/biotest/_version.py", # CHANGE ] [tool.ruff.lint] @@ -176,11 +176,11 @@ typeCheckingMode = "standard" useLibraryCodeForTypes = true autoImportCompletions = true -pythonVersion = "3.11" +pythonVersion = "3.10" # pythonPlatform = "Linux" [tool.coverage.report] omit = [ - "src/ml_project/_version.py", # CHANGE + "src/biotest/_version.py", # CHANGE # OPTIONALLY ADD MORE LATER ] diff --git a/replace_project_name.sh b/replace_project_name.sh deleted file mode 100644 index 966b94b..0000000 --- a/replace_project_name.sh +++ /dev/null @@ -1,39 +0,0 @@ -# NOTE: Use this to replace all strings in the project template with the new project name, -# then delete this file. - -# python-project-template-2024 -> new-ml-project -github_repo_name=new-project - -# ml_project -> new_module_name -module_name=new_project - -# ml-project -> new-package-name -package_name=new-project - -# ML_PROJECT -> NEW_PROJECT -# e.g. ML_PROJECT_DATA_DIR -> NEW_PROJECT_DATA_DIR -envvar_name=NEW_PROJECT - -# Python Project Template -> New Project -doc_title="New Project" -doc_url='https://deargen-ai.gitlab.io/new-project-docs' - - -if [[ "$OSTYPE" == "darwin"* ]]; then - SED="gsed" - if ! command -v gsed &> /dev/null; then - echo "gsed is not installed. Please install it using 'brew install gnu-sed'" - exit 1 - fi -else - SED="sed" -fi - -rg -g '!replace_project_name.sh' --files-with-matches -l python-project-template-2024 | xargs $SED -i "s/python-project-template-2024/$github_repo_name/g" -rg -g '!replace_project_name.sh' --files-with-matches -l ml_project | xargs $SED -i "s/ml_project/$module_name/g" -rg -g '!replace_project_name.sh' --files-with-matches -l ml-project | xargs $SED -i "s/ml-project/$package_name/g" -rg -g '!replace_project_name.sh' --files-with-matches -l ML_PROJECT | xargs $SED -i "s/ML_PROJECT/$envvar_name/g" -rg -g '!replace_project_name.sh' --files-with-matches -l "Python Project Template" | xargs $SED -i "s/Python Project Template/$doc_title/g" -rg -g '!replace_project_name.sh' --files-with-matches -l 'https://deargen-ai.gitlab.io/python-project-template-docs' | xargs $SED -i "s|https://deargen-ai.gitlab.io/python-project-template-docs|$doc_url|g" - -mv src/ml_project src/$module_name diff --git a/src/ml_project/__init__.py b/src/biotest/__init__.py similarity index 83% rename from src/ml_project/__init__.py rename to src/biotest/__init__.py index 9ed66ae..623e364 100644 --- a/src/ml_project/__init__.py +++ b/src/biotest/__init__.py @@ -9,7 +9,7 @@ __version__ = _version.get_versions()["version"] -default_log_level = os.environ.get("ML_PROJECT_LOG_LEVEL") +default_log_level = os.environ.get("BIOTEST_LOG_LEVEL") if default_log_level is None: default_log_level = "INFO" @@ -17,7 +17,7 @@ # If you installed with `pip install .`, then the path will be different. PROJECT_DIR = Path(__file__).parent.parent.parent -DATA_DIR = os.environ.get("ML_PROJECT_DATA_DIR") +DATA_DIR = os.environ.get("BIOTEST_DATA_DIR") DATA_DIR = ( PROJECT_DIR / "data" if DATA_DIR is None or DATA_DIR == "" else Path(DATA_DIR) ) diff --git a/src/ml_project/_version.py b/src/biotest/_version.py similarity index 99% rename from src/ml_project/_version.py rename to src/biotest/_version.py index eb1598c..5f17839 100644 --- a/src/ml_project/_version.py +++ b/src/biotest/_version.py @@ -51,8 +51,8 @@ def get_config() -> VersioneerConfig: cfg.VCS = "git" cfg.style = "pep440" cfg.tag_prefix = "v" - cfg.parentdir_prefix = "ml-project-" - cfg.versionfile_source = "src/ml_project/_version.py" + cfg.parentdir_prefix = "biotest-" + cfg.versionfile_source = "src/biotest/_version.py" cfg.verbose = False return cfg diff --git a/src/ml_project/cli/__init__.py b/src/biotest/cli/__init__.py similarity index 100% rename from src/ml_project/cli/__init__.py rename to src/biotest/cli/__init__.py diff --git a/src/ml_project/cli/main.py b/src/biotest/cli/main.py similarity index 100% rename from src/ml_project/cli/main.py rename to src/biotest/cli/main.py diff --git a/src/ml_project/health/__init__.py b/src/biotest/health/__init__.py similarity index 68% rename from src/ml_project/health/__init__.py rename to src/biotest/health/__init__.py index 897053c..1074721 100644 --- a/src/ml_project/health/__init__.py +++ b/src/biotest/health/__init__.py @@ -15,16 +15,16 @@ def check_binaries(): def check_env(): """Check environment variables.""" - ml_project_data_dir = os.environ.get("ML_PROJECT_DATA_DIR") + biotest_data_dir = os.environ.get("BIOTEST_DATA_DIR") - if ml_project_data_dir is None: + if biotest_data_dir is None: logger.warning( - "🤒 Please set the environment variable ML_PROJECT_DATA_DIR to the path of the data directory.\n" + "🤒 Please set the environment variable BIOTEST_DATA_DIR to the path of the data directory.\n" f"Otherwise, the default {DATA_DIR} will be used." ) return False - logger.info(f"✅ ML_PROJECT_DATA_DIR is set to {ml_project_data_dir}") + logger.info(f"✅ BIOTEST_DATA_DIR is set to {biotest_data_dir}") return True diff --git a/src/ml_project/two_numbers.py b/src/biotest/two_numbers.py similarity index 100% rename from src/ml_project/two_numbers.py rename to src/biotest/two_numbers.py diff --git a/src/biotest/utils/__init__.py b/src/biotest/utils/__init__.py new file mode 100644 index 0000000..b255cbb --- /dev/null +++ b/src/biotest/utils/__init__.py @@ -0,0 +1,5 @@ +from biotest.utils.log import setup_logging + +__all__ = [ + "setup_logging", +] diff --git a/src/ml_project/utils/config.py b/src/biotest/utils/config.py similarity index 100% rename from src/ml_project/utils/config.py rename to src/biotest/utils/config.py diff --git a/src/ml_project/utils/log.py b/src/biotest/utils/log.py similarity index 96% rename from src/ml_project/utils/log.py rename to src/biotest/utils/log.py index 0247540..2cc94fa 100644 --- a/src/ml_project/utils/log.py +++ b/src/biotest/utils/log.py @@ -8,7 +8,7 @@ from rich.logging import RichHandler from rich.theme import Theme -from ml_project import LOG_DIR, PROJECT_DIR, __version__, default_log_level +from biotest import LOG_DIR, PROJECT_DIR, __version__, default_log_level # 옵션으로 `from accelerate.logging import get_logger` # 사용하시면 로깅할 때 main_process_only=False, in_order=True 등 옵션 사용 가능합니다 @@ -38,7 +38,7 @@ def setup_logging( You should call this function at the beginning of your script. Args: - console_level: Logging level for console. Defaults to INFO or env var ML_PROJECT_LOG_LEVEL. + console_level: Logging level for console. Defaults to INFO or env var BIOTEST_LOG_LEVEL. output_files: List of output file paths, relative to LOG_DIR. If None, use default. file_levels: List of logging levels for each output file. If None, use default. """ @@ -122,7 +122,7 @@ def setup_logging( # Add handlers to the logger root_logger.addHandler(f_handler) - logger.info(f"ml-project {__version__}") + logger.info(f"biotest {__version__}") for log_path in log_paths: logger.info(f"Logging to {log_path}") diff --git a/src/ml_project/utils/__init__.py b/src/ml_project/utils/__init__.py deleted file mode 100644 index bb13074..0000000 --- a/src/ml_project/utils/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -from ml_project.utils.log import setup_logging - -__all__ = [ - "setup_logging", -] diff --git a/template.env b/template.env index aacc9c0..41e8170 100644 --- a/template.env +++ b/template.env @@ -1,3 +1,3 @@ # NOTE: make sure to rename this file to .env -ML_PROJECT_LOG_LEVEL=INFO -ML_PROJECT_DATA_DIR= +BIOTEST_LOG_LEVEL=INFO +BIOTEST_DATA_DIR= diff --git a/tests/conftest.py b/tests/conftest.py index 525205e..a552c5c 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,6 @@ import pytest -from ml_project.two_numbers import TwoNumbers +from biotest.two_numbers import TwoNumbers @pytest.fixture(scope="session") diff --git a/tests/test_add.py b/tests/test_add.py index 9e0232f..d7f31e1 100644 --- a/tests/test_add.py +++ b/tests/test_add.py @@ -1,6 +1,6 @@ import pytest -from ml_project.two_numbers import TwoNumbers +from biotest.two_numbers import TwoNumbers def test_zero_zero(zero_zero): diff --git a/tools/examples/color_logging_main.py b/tools/examples/color_logging_main.py deleted file mode 100644 index 344298b..0000000 --- a/tools/examples/color_logging_main.py +++ /dev/null @@ -1,33 +0,0 @@ -"""Example main function template.""" - -import rich.traceback -from dotenv import load_dotenv - -# 다른 import 하기 전, 맨 위에 추가하면 import 과정에서 생기는 에러들을 rich로 출력할 수 있습니다. -rich.traceback.install(show_locals=True) -load_dotenv() - -import logging - -from ml_project.utils import setup_logging - -logger = logging.getLogger(__name__) - - -def main(): - """ - Log an info message and an exception. - - Raises: - Exception: - """ - logger.info("This is an info message") - raise Exception("This is an exception") # noqa: TRY002 - - -if __name__ == "__main__": - try: - setup_logging() - main() - except Exception: - logger.exception("Exception occurred")