v0.5.0

Key Changes

• Adapt changelog-action and parse-changelog-action
  • The changelog will not be commited automatically. Instead, it will create a PR.
  • Merging the PR will create a release.

💥 BREAKING CHANGES

• due to 722b226 - deploy creates a PR, and merging it will create a release (commit by @kiyoon):

  deploy creates a PR, and merging it will create a release

✨ New Features

• 9b9a822 - ci: basedpyright type checking (commit by @kiyoon)
• e96c60f - yaml, yml editorconfig (commit by @kiyoon)
• 3659b36 - editorconfig vscode (commit by @kiyoon)
• 722b226 - deploy creates a PR, and merging it will create a release (commit by @kiyoon)

🐛 Bug Fixes

• 476d317 - vscode settings (commit by @kiyoon)

🔧 Chores

• e5bd44a - taplo format pyproject.toml (commit by @kiyoon)

v0.4.1

✨ New Features

• e79995e - more project urls (commit by @kiyoon)
• 3ee3c22 - mkdocstrings make indented (commit by @kiyoon)
• 3f9fef3 - ruff select all rules except ignored rules (commit by @kiyoon)
• ebc31f1 - fix ruff rules (commit by @kiyoon)
• a4e93df - ruff ignore todo comments (commit by @kiyoon)
• a84c483 - nbval Jupyter Notebook regression testing (commit by @kiyoon)
• 12b98ec - ignore ruff ARG (commit by @kiyoon)
• 62c86e5 - ruff ignore TC in cli (commit by @kiyoon)
• 0fe5c9a - remove PERF ruff lint (commit by @kiyoon)
• 147e072 - optionally support windows (commit by @kiyoon)
• d78ae4f - typer -> cyclopts (commit by @kiyoon)
• 2fda191 - vscode basedpyright (commit by @kiyoon)
• 9b5dea2 - no ruff T201 (print statement) in ipynb (commit by @kiyoon)

🐛 Bug Fixes

• 2e154ef - build include directories (commit by @kiyoon)
• d6ee73b - mkdocs: github flavored alert not rendered when used with snippets (commit by @kiyoon)
• d4c1f63 - wrong year in LICENSE (commit by @kiyoon)
• aeb670f - nbval ignore kernel in notebook. Use current env (commit by @kiyoon)

v0.4.0

🔆 Highlights

• Setuptools -> Hatchling backend
• Versioneer -> version-pioneer (pep440-master style)

💥 BREAKING CHANGES

• due to 5cb3c66 - hatchling, version-pioneer (commit by @kiyoon):

  hatchling, version-pioneer

✨ New Features

• e44cf89 - do not fix ruff version (commit by @kiyoon)
• e965403 - ignore D205 1 blank line lint (commit by @kiyoon)
• 2c00c0e - typer help text from docstring (commit by @kiyoon)
• 5cb3c66 - hatchling, version-pioneer (commit by @kiyoon)
• 1f8ca7b - version style with master and dev branch distance (commit by @kiyoon)

🐛 Bug Fixes

• a855d64 - pkg_is_editable (commit by @kiyoon)

♻️ Refactors

• f1e4220 - editable install detect (commit by @kiyoon)

🔧 Chores

• 76d4f58 - ignore logger.exception lint (commit by @kiyoon)
• 54a01de - pip compile (commit by @kiyoon)

v0.3.3

✨ New Features

• 8a87e9a - mkdocs: use github flavoured callouts (commit by @kiyoon)
• 40fd8c5 - mkdocs: github admonitions (commit by @kiyoon)
• 94fc67e - mkdocs: math equations (commit by @kiyoon)
• c6c9616 - mkdocs: github style (commit by @kiyoon)
• 35b30ed - ruff: remove magic-value-comparison (PLR2004) rule (commit by @kiyoon)
• 7232d17 - move pip-compile configuration to pyproject.toml (commit by @kiyoon)
• 23a08c1 - remove dependabot (commit by @kiyoon)
• 11c5f50 - use lint-essential (central managed rulesets) (commit by @kiyoon)
• ae7cb50 - INP only in src/ (commit by @kiyoon)

🐛 Bug Fixes

• 2c374f1 - log path logging (commit by @kiyoon)
• a94b965 - setuptools pypi publish bug (commit by @kiyoon)
• 2127fd3 - INP001 directories (commit by @kiyoon)

♻️ Refactors

• d47ce9e - move update_data_dirs() up (commit by @kiyoon)

v0.3.2

✨ New Features

• 44e1aa5 - essential lint as test (commit by @kiyoon)

🐛 Bug Fixes

• 5ccd478 - pyproject toml (commit by @kiyoon)

♻️ Refactors

• 792dba3 - rename some variables (app_name -> APP_NAME etc.) (commit by @kiyoon)

✅ Tests

• 7e3eed0 - log_cli (commit by @kiyoon)

🔧 Chores

• 6d46488 - type (commit by @kiyoon)
• f18dda3 - english docs (commit by @kiyoon)

v0.3.1

💥 BREAKING CHANGES

• due to cf178a5 - ml_project.utils.log.setup_logging -> ml_project.setup_logging (commit by @kiyoon):

  ml_project.utils.log.setup_logging -> ml_project.setup_logging

♻️ Refactors

• cf178a5 - ml_project.utils.log.setup_logging -> ml_project.setup_logging (commit by @kiyoon)

v0.3.0

🔆 Highlights

기존 템플릿은 pip install -e . 처럼 development mode로 설치하는 것을 기본 전제로 했다. 하지만,

기존 방법의 단점:

• 이렇게 하면 무조건 repository clone을 해야 사용할 수 있으므로 간단히 설치해 CLI를 사용하기 어려워진다.

변경 방법의 장점: 설치가 훨씬 수월해진다.

• pip install . (-e 없이) 해도 사용 가능. (PROJECT_DIR만 사용 못함)
• pipx install ., uv tool install .처럼 API없이 CLI만 사용하도록 설치도 가능.

Breaking Changes (주의 사항)

• PROJECT_DIR type이 Path -> Path | None으로 변경. Non-development mode install (pip install -e 안했을때) None으로 설정.
  • 웬만하면 사용 자제하고 개발/테스트할 때만 사용 권장.
• setup_logging() default로 file logging 안하도록 변경. setup_logging(log_dir=LOG_DIR) 사용.

New Features

• ml-project config CLI로 template.env를 가장 적합한 디렉토리에 복사함.

Auto-generated changelog

💥 BREAKING CHANGES

• due to ed5d8ed - drop windows (not in default) (commit by @kiyoon):

  drop windows (not in default)

• due to b2fa2e9 - prevent circular import (commit by @kiyoon):

  prevent circular import

• due to 6b0e335 - non-development installation support (PR #28 by @kiyoon):

  non-development installation support (#28)

✨ New Features

• 088ac67 - update requirements_docs.in to support python 3.12 (commit by @kiyoon)
• 01ede09 - vscode default settings (commit by @kiyoon)
• 9772d0e - ruff: ignore unused imports in init.py (commit by @kiyoon)
• ed5d8ed - pip-compile: drop windows (not in default) (commit by @kiyoon)
• 3ced2e3 - biotest (commit by @kiyoon)
• d216290 - ban lightning (commit by @kiyoon)
• d14c903 - add banned api (commit by @kiyoon)
• 051e2e6 - make pylinter less strict (commit by @kiyoon)
• 4a24cc5 - ruff ban os.system (commit by @kiyoon)
• 3120164 - ruff: ban easydict (commit by @kiyoon)
• 6b0e335 - non-development installation support (PR #28 by @kiyoon)

🐛 Bug Fixes

• 53fc9f5 - tests directory doesn't need namespace (commit by @kiyoon)
• 5b2ee15 - disable some ruff rules for CLI (commit by @kiyoon)
• 99972df - ruff and health check logic (commit by @kiyoon)
• b2fa2e9 - prevent circular import (commit by @kiyoon)
• 6c3e3dc - config: improve abstraction, doctest (commit by @kiyoon)

♻️ Refactors

• fb23283 - remove clearml dependency and example (commit by @kiyoon)

🔧 Chores

• ac88a3e - update first party (commit by @kiyoon)

v0.2.5

💥 BREAKING CHANGES

• due to 0ee9ddb - easier gitlab page setup guide (but defaults to master branch (commit by @kiyoon):

  easier gitlab page setup guide (but defaults to master branch

✨ New Features

• 0ee9ddb - easier gitlab page setup guide (but defaults to master branch (commit by @kiyoon)

🐛 Bug Fixes

• 872bbf9 - replace-name: mac compatible sed (commit by @kiyoon)
• 3f0aae4 - ci: check mkdocs (PR #27 by @kiyoon)
• e3a4041 - replace_project_name.sh: sed issue with mac (commit by @kiyoon)

v0.2.4

✨ New Features

• b6360ab - ci: add exclude-types input to deploy.yml, fix(ci): check-docs.yml (PR #26 by @kiyoon)

v0.2.3

✨ New Features

• 2261a27 - micromamba cache better key (commit by @kiyoon)

🐛 Bug Fixes

• bebe843 - config: undefined variable (commit by @kiyoon)
• becff68 - relax pylint max statements (commit by @kiyoon)
• 580b4ee - ci: ubuntu-24.04 (commit by @kiyoon)
• 54f0cae - ci: deploy dry run (commit by @kiyoon)