pyproject.toml

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "esp_idf_panic_decoder"
authors = [
    {name = "Espressif Systems"},
]
description = "ESP-IDF panic decoder"
readme = {file = "README.md", content-type = "text/markdown"}
requires-python = ">=3.7"
keywords = ["python", "espressif", "gdb", "panic-decoder"]
license = {file = "LICENSE"}
classifiers = [
    'Development Status :: 5 - Production/Stable',
    'Intended Audience :: Developers',
    'Natural Language :: English',
    'Environment :: Console',
    'Topic :: Software Development :: Embedded Systems',
    'License :: OSI Approved :: Apache Software License',
    'Programming Language :: Python :: 3.7',
    'Programming Language :: Python :: 3.8',
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Operating System :: POSIX',
    'Operating System :: Microsoft :: Windows',
    'Operating System :: MacOS :: MacOS X',
]
dynamic = ['version']
dependencies = ["pyelftools"]

[project.urls]
Homepage = "https://github.com/espressif/esp-idf-panic-decoder"

[project.optional-dependencies]
dev = [
    "pre-commit",
    "commitizen",
]

[tool.setuptools]
packages = ["esp_idf_panic_decoder"]

[tool.setuptools.dynamic]
version = {attr = "esp_idf_panic_decoder.__version__"}

[tool.commitizen]
version = "1.2.1"
update_changelog_on_bump = true
tag_format = "v$version"
changelog_merge_prerelease = true
annotated_tag = true
changelog_start_rev = "v0.2.0"
bump_message = "change: Update version to $new_version"
version_files = [
    "esp_idf_panic_decoder/__init__.py:__version__"
]
change_type_order = [
    "BREAKING CHANGE",
    "New Features",
    "Bug Fixes",
    "Code Refactoring",
    "Performance Improvements"
]

[tool.commitizen.change_type_map]
feat = "New Features"
fix = "Bug Fixes"
refactor = "Code Refactoring"
perf = "Performance Improvements"

[tool.pylint]
    [tool.pylint.'BASIC']
        variable-rgx = "[a-z_][a-z0-9_]{1,30}$" # Variable names must start with a lowercase letter or underscore, followed by any combination of lowercase letters, numbers, or underscores, with a total length of 2 to 30 characters.

    [tool.pylint.'MESSAGES CONTROL']
        disable = [
            "duplicate-code",             # R0801: Similar lines in %s files
            "fixme",                      # W0511: Used when TODO/FIXME is encountered
            "import-error",               # E0401: Used when pylint has been unable to import a module
            "import-outside-toplevel",    # E0402: Imports should usually be on top of the module
            "missing-class-docstring",    # C0115: Missing class docstring
            "missing-function-docstring", # C0116: Missing function or method docstring
            "missing-module-docstring",   # C0114: Missing module docstring
            "no-name-in-module",          # W0611: Used when a name cannot be found in a module
            "too-few-public-methods",     # R0903: Too few public methods of class
            "too-many-branches",          # R0912: Too many branches
            "too-many-locals",            # R0914: Too many local variables
            "too-many-return-statements", # R0911: Too many return statements
            "too-many-statements",        # R0915: Too many statements
            "ungrouped-imports",          # C0412: Imports should be grouped by packages
        ]

    [tool.pylint.'FORMAT']
        max-line-length = 120

[tool.ruff]
    line-length    = 120
    select         = ['E', 'F', 'W']
    target-version = "py37"

[tool.mypy]
    disallow_incomplete_defs = false # Disallows defining functions with incomplete type annotations
    disallow_untyped_defs    = false # Disallows defining functions without type annotations or with incomplete type annotations
    ignore_missing_imports   = true  # Suppress error messages about imports that cannot be resolved
    python_version           = "3.9" # Specifies the Python version used to parse and check the target program
    warn_no_return           = true  # Shows errors for missing return statements on some execution paths
    warn_return_any          = true  # Shows a warning when returning a value with type Any from a function declared with a non- Any return type