chore(deps): update dependencies and improve project configuration

Author: hasansezertasan

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+<!-- TODO @hasansezertasan: Conventional changelog should be optional. -->
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

pyproject.toml

@@ -62,34 +62,38 @@ projectname = "projectname.cli:app"
 [dependency-groups]
 dev = [
   "projectname[cli]",
-  "tox>=4.25.0",
-  "tox-uv>=1.13.1",
+  "tox==4.31.0",
+  "tox-uv==1.29.0",
   { include-group = "lint" },
   { include-group = "test" },
   { include-group = "tool" },
 ]
 lint = [
-  "mypy>=1.18.2",
-  "pyright>=1.1.406",
+  "mypy==1.18.2",
+  "pyright==1.1.406",
   "ty==0.0.1a23",
-  "pyrefly==0.37.0",
-  "ruff>=0.14.1",
-  "taplo>=0.9.3",
-  "typos>=1.38.1",
-  "validate-pyproject[all]>=0.24.1",
-  "vulture>=2.14",
-  "slotscheck>=0.19.1",
+  "pyrefly==0.38.1",
+  "ruff==0.14.1",
+  "taplo==0.9.3",
+  "typos==1.38.1",
+  "validate-pyproject[all]==0.24.1",
+  "vulture==2.14",
+  "slotscheck==0.19.1",
 ]
 test = [
   "coverage-enable-subprocess==1.0",
-  "coverage[toml]~=7.4",
-  "pytest-dependency>=0.6.0",
-  "pytest-mock~=3.12",
-  "pytest-rerunfailures~=14.0",
-  "pytest-xdist[psutil]~=3.5",
+  "coverage[toml]==7.4",
+  "pytest-dependency==0.6.0",
+  "pytest-mock==3.12",
+  "pytest-rerunfailures==16.1",
+  "pytest-xdist[psutil]==3.5",
   "pytest==8.4.2",
 ]
-tool = ["poethepoet==0.37.0", "pre-commit==4.3.0", "commitizen==4.9.1"]
+tool = [
+  "pre-commit==4.3.0",
+  "poethepoet==0.37.0",
+  "commitizen==4.9.1",
+]
 
 
 [tool.uv]
@@ -98,6 +102,7 @@ cache-keys = [
   { git = { commit = true, tags = true } },
 ]
 trusted-publishing = "always"
+add-bounds = "exact"
 
 
 [build-system]
@@ -118,7 +123,7 @@ hooks.vcs.version-file = "src/projectname/_version.py"
 version_scheme = "only-version"
 local_scheme = "no-local-version"
 
-
+# TODO @hasansezertasan: Commitizen should be optional.
 [tool.commitizen]
 name = "cz_conventional_commits"
 version_provider = "scm"
@@ -192,39 +197,39 @@ preview = true
 select = ["ALL"]
 
 
-[tool.ruff.lint.per-file-ignores]
-"tests/*.py" = ['S101']
+# TODO @hasansezertasan: Update the author name and email
+[tool.ruff.lint.flake8-copyright]
+author = "Hasan Sezer Taşan <hasansezertasan@gmail.com>"
 
 
-[tool.ruff.lint.pyupgrade]
-keep-runtime-typing = true
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+
+[tool.ruff.lint.mccabe]
+max-complexity = 5
 
 
 [tool.ruff.lint.pycodestyle]
 ignore-overlong-task-comments = true
 
 
-# TODO @hasansezertasan: Update the author name and email
-[tool.ruff.lint.flake8-copyright]
-author = "Hasan Sezer Taşan <hasansezertasan@gmail.com>"
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
 
 
-[tool.ruff.lint.flake8-tidy-imports]
-ban-relative-imports = "all"
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = ['S101']
 
 
-[tool.ruff.lint.pydocstyle]
-convention = "pep257"
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
 
 
 [tool.ruff.lint.ruff]
 parenthesize-tuple-in-subscript = true
 
 
-[tool.ruff.lint.mccabe]
-max-complexity = 5
-
-
 [tool.mypy]
 files = ["src"]
 pretty = true
@@ -255,6 +260,7 @@ python-version = "3.10"
 project-includes = ["src"]
 
 
+# TODO @hasansezertasan: poethepoet should be optional.
 [tool.poe]
 executor.type = "uv"
 
@@ -326,6 +332,7 @@ description = "Run Linters and Formatters"
 allowlist_externals = ["actionlint", "yamlfmt"]
 
 
+# TODO @hasansezertasan: This should be available if the project is a CLI project.
 [tool.tox.env.run]
 commands = [["projectname", "version", { replace = "posargs", extend = true }]]
 description = "Run the application"

src/projectname/cli.py

@@ -4,10 +4,11 @@
 from __future__ import annotations
 
 import platform
-from importlib.metadata import version
+from importlib.metadata import Distribution
 
 import typer
 
+from projectname.config import PROJECT_NAME
 from projectname.logging_setup import logger
 
 app = typer.Typer(
@@ -26,8 +27,9 @@ def show_version() -> None:
     Example output:
         0.1.0
     """
+    distribution = Distribution.from_name(PROJECT_NAME)
     logger.info("Command `version` called.")
-    typer.echo(version("projectname"))
+    typer.echo(distribution.version)
     logger.info("Version displayed successfully.")
 
 
@@ -43,10 +45,11 @@ def info() -> None:
         Python Version: 3.8.20 (CPython)
         Platform: Darwin
     """
+    distribution = Distribution.from_name(PROJECT_NAME)
     logger.info("Command `info` called.")
     python_version = platform.python_version()
     python_implementation = platform.python_implementation()
-    typer.echo(f"Application Version: {version('projectname')}")
+    typer.echo(f"Application Version: {distribution.version}")
     typer.echo(f"Python Version: {python_version} ({python_implementation})")
     typer.echo(f"Platform: {platform.system()}")
     logger.info("Application information displayed successfully.")

src/projectname/config.py

@@ -2,9 +2,13 @@
 
 from pathlib import Path
 
-ROOT_FOLDER_NAME = ".projectname"
-DEFAULT_USER_HOME_CACHE_PATH = Path.home() / ROOT_FOLDER_NAME
-"""Path to the user home cache path."""
-
-log_file_path: Path = DEFAULT_USER_HOME_CACHE_PATH / "projectname.log"
+PROJECT_NAME: str = "projectname"
+"""Name of the project."""
+ROOT_FOLDER_NAME: str = f".{PROJECT_NAME}"
+"""Name of the root folder."""
+ROOT_FOLDER_PATH: Path = Path.home() / ROOT_FOLDER_NAME
+"""Path to the root folder."""
+LOG_FILE_PATH: Path = ROOT_FOLDER_PATH / "main.log"
 """Path to the log file."""
+CONFIG_FILE_PATH: Path = ROOT_FOLDER_PATH / "config.json"
+"""Path to the config file."""

src/projectname/logging_setup.py

@@ -13,30 +13,29 @@
 import sys
 from logging.handlers import RotatingFileHandler
 
-from projectname.config import DEFAULT_USER_HOME_CACHE_PATH, log_file_path
+from projectname.config import ROOT_FOLDER_PATH, LOG_FILE_PATH, PROJECT_NAME
 
 
 def setup_logger() -> logging.Logger:
-    """Set up and return the main logger for the projectname application.
+    """Set up and return the main logger for the keycast application.
 
     Ensures that handlers are only added once to avoid duplicate log entries
     if this module is imported multiple times.
 
     Returns:
-        logging.Logger: Configured logger for the projectname application.
-
+        logging.Logger: Configured logger for the keycast application.
     """
-    logger_ = logging.getLogger("projectname")
+    logger_ = logging.getLogger(PROJECT_NAME)
     logger_.setLevel(logging.INFO)
 
     # Only add handlers if they haven't been added yet
     if not logger_.handlers:
         # Ensure the log file exists
-        DEFAULT_USER_HOME_CACHE_PATH.mkdir(parents=True, exist_ok=True)
+        ROOT_FOLDER_PATH.mkdir(parents=True, exist_ok=True)
 
         # Create a file handler that logs all messages
         file_handler = RotatingFileHandler(
-            log_file_path, maxBytes=10 * 1024 * 1024, backupCount=5
+            LOG_FILE_PATH, maxBytes=10 * 1024 * 1024, backupCount=5
         )
         file_handler.setLevel(logging.INFO)