pyproject.toml

# vim: set filetype=toml fileencoding=utf-8:
# -*- mode: toml ; coding: utf-8 -*-

[build-system]
requires = [
  'hatchling',
  # 'hatch-pyinstaller',
]
build-backend = 'hatchling.build'

[project]
name = 'mimeogram'
description = 'Exchange of file collections with LLMs.'
dynamic = [ 'version' ]
license = 'Apache-2.0'
readme = { 'file' = 'README.rst', 'content-type' = 'text/x-rst' }
requires-python = '>= 3.12'
dependencies = [
  'accretive~=4.1',
  'aiofiles',
  'detextive~=3.1',
  'gitignorefile',
  'httpx',
  'patiencediff',
  'pyperclip',
  'readchar',
  'rich',
  'tiktoken',
  'typing-extensions',
  'wcmatch',
  # --- BEGIN: Injected by Copier ---
  'absence~=1.1',
  'dynadoc~=1.4',
  'frigid~=4.2',
  'emcd-appcore[cli]~=1.8',
  # --- END: Injected by Copier ---
]
classifiers = [ # https://pypi.org/classifiers
  'Development Status :: 4 - Beta',
  'Intended Audience :: Developers',
  'Intended Audience :: End Users/Desktop',
  'License :: OSI Approved :: Apache Software License',
  'Programming Language :: Python :: 3 :: Only',
  # --- BEGIN: Injected by Copier ---
  'Programming Language :: Python :: 3.12',
  'Programming Language :: Python :: 3.13',
  'Programming Language :: Python :: 3.14',
  'Programming Language :: Python :: 3.15',
  'Programming Language :: Python :: Implementation :: CPython',
  # --- END: Injected by Copier ---
  'Topic :: Communications :: Chat',
  'Topic :: Scientific/Engineering :: Artificial Intelligence',
  'Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator',
  'Topic :: Text Processing :: General',
]
keywords = [ 'ai', 'llm', 'documents', 'interchange', 'cli' ]
[[project.authors]]
name = 'Eric McDonald'
email = 'emcd@users.noreply.github.com'
[project.scripts]
mimeogram = 'mimeogram:main'
[project.urls]
'Homepage' = 'https://github.com/emcd/python-mimeogram'
'Documentation' = 'https://emcd.github.io/python-mimeogram'
'Download' = 'https://pypi.org/project/mimeogram/#files'
'Source Code' = 'https://github.com/emcd/python-mimeogram'
'Issue Tracker' = 'https://github.com/emcd/python-mimeogram/issues'

[tool.SELF]
year-of-origin = 2025

# https://coverage.readthedocs.io/en/latest/config.html
[tool.coverage.paths]
gha-runners = [
  '/home/runner/work/python-mimeogram/python-mimeogram/',
  '/Users/runner/work/python-mimeogram/python-mimeogram/',
  'C:\a\python-mimeogram\python-mimeogram\',
  'D:\a\python-mimeogram\python-mimeogram\',
]
[tool.coverage.run]
branch = true
command_line = '-m pytest'
data_file = '.auxiliary/caches/pytest/coverage.sqlite3'
parallel = true
source = [ 'sources' ]
[tool.coverage.html]
directory = '.auxiliary/artifacts/coverage-pytest'
[tool.coverage.xml]
output = '.auxiliary/artifacts/coverage-pytest/coverage.xml'

# https://hatch.pypa.io/latest/config/metadata/
[tool.hatch.build]
directory = '.auxiliary/artifacts/hatch-build'
[tool.hatch.build.targets.sdist]
only-include = [
  'sources/mimeogram',
  # --- BEGIN: Injected by Copier ---
  'data',
  # --- END: Injected by Copier ---
]
strict-naming = false
[tool.hatch.build.targets.wheel]
only-include = [
  'sources/mimeogram',
  # --- BEGIN: Injected by Copier ---
  'data',
  # --- END: Injected by Copier ---
]
strict-naming = false
[tool.hatch.build.targets.wheel.sources]
'sources/mimeogram' = 'mimeogram'
# --- BEGIN: Injected by Copier ---
'data' = 'mimeogram/data'
# --- END: Injected by Copier ---
[tool.hatch.envs.default]
python = '3.12'
[tool.hatch.envs.develop]
description = ''' Development environment. '''
builder = true
dependencies = [
  'coverage[toml]',
  'furo',
  'isort',
  'myst-parser',
  'pyright',
  'pytest',
  'pytest-asyncio',
  'pytest-httpx',
  'pytest-mock',
  'ruff',
  'sphinx',
  'sphinx-copybutton',
  'sphinx-inline-tabs',
  'towncrier',
  'vulture',
  # --- BEGIN: Injected by Copier ---
  'pyinstaller',
  'hypothesis',
  # --- END: Injected by Copier ---
]
post-install-commands = [
  # --- BEGIN: Injected by Copier ---
  # --- END: Injected by Copier ---
]
[tool.hatch.envs.develop.env-vars]
PYTHONUNBUFFERED = 'TRUE' # TODO: Only for coverage/pytest.
# --- BEGIN: Injected by Copier ---
HYPOTHESIS_STORAGE_DIRECTORY = '.auxiliary/caches/hypothesis'
# --- END: Injected by Copier ---
[tool.hatch.envs.develop.scripts]
docsgen = [
  """sphinx-build -E -b linkcheck -d .auxiliary/caches/sphinx --quiet \
      documentation .auxiliary/artifacts/sphinx-linkcheck""",
  """sphinx-build -a -d .auxiliary/caches/sphinx --quiet \
      documentation .auxiliary/artifacts/sphinx-html""",
]
check-ignored-links = [
  """python .auxiliary/scripts/check-ignored-links.py""",
]
fragments = [
  """python .auxiliary/scripts/validate-fragments.py""",
]
module-sizes = [
  """python .auxiliary/scripts/validate-module-sizes.py""",
]
linters = [
  """ruff check --quiet sources documentation tests""",
  # External install only (e.g. uv tool install): a develop dependency
  # cycles for packages below emcd-vibe-linter in the stack.
  #"""vibelinter check""",
  # --- BEGIN: Injected by Copier ---
  # --- END: Injected by Copier ---
  """isort --check-only --diff sources tests""",
  """pyright sources""",
  'fragments',
  'module-sizes',
]
packagers = [
  """hatch build""",
  # --- BEGIN: Injected by Copier ---
  """pyinstaller \
      --clean \
      --distpath=.auxiliary/artifacts/pyinstaller \
      pyinstaller.spec""",
  # --- END: Injected by Copier ---
]
testers-documentation = [
  """coverage run -m sphinx.cmd.build \
      -E -b doctest -d .auxiliary/caches/sphinx --quiet \
      documentation .auxiliary/artifacts/sphinx-doctest""",
]
testers-serotine = [ """coverage run -m pytest -m slow"""  ]
testers-no-reports = [
  'coverage run',
  'testers-documentation',
  'testers-serotine',
]
testers = [
  'coverage erase',
  'testers-no-reports',
  'coverage combine',
  'coverage report --skip-covered',
  'coverage html',
  'coverage xml',
]
make-all = [
  'linters',
  'testers',
  'packagers',
  'docsgen',
]
[tool.hatch.envs.qa]
description = ''' Quality assurance environment. '''
template = 'develop'
[[tool.hatch.envs.qa.matrix]]
python = [
    '3.12',
    '3.13',
    '3.14',
    '3.15',
]
[tool.hatch.metadata]
allow-direct-references = true
[tool.hatch.version]
path = 'sources/mimeogram/__init__.py'

# https://pycqa.github.io/isort/docs/configuration/config_files.html
[tool.isort]
# profile = 'black'
src_paths = [ 'sources', 'tests' ]
case_sensitive = true
# ensure_newline_before_comments = true
# force_sort_within_sections = true
ignore_whitespace = true
include_trailing_comma = true
known_first_party = [ 'mimeogram' ]
lines_between_types = 1
line_length = 79
multi_line_output = 3
quiet = true
# skip_gitignore = true
skip_glob = [ '*/__/imports.py', '*/__init__.py' ]
split_on_trailing_comma = true
use_parentheses = true

# https://mypy.readthedocs.io/en/stable/config_file.html
[tool.mypy]
# Note: Due to repeated painful experiences with Mypy, we use Pyright instead.
#       Pyright properly handles TypeVars, etc...
cache_dir = '.auxiliary/caches/mypy'
exclude = [ '.*' ]  # Ignore everything
ignore_errors = true
follow_imports = 'skip'
pretty = true
strict = false

# https://microsoft.github.io/pyright/#/configuration
[tool.pyright]
ignore = [ '.auxiliary', 'documentation', 'tests' ] # Ignore diagnostics.
include = [ 'sources', 'tests' ]      # Consider for operations.
reportConstantRedefinition = true
reportInvalidTypeVarUse = true
reportMatchNotExhaustive = true
reportMissingImports = true
reportMissingTypeStubs = true
reportMissingTypeArgument = true
reportPossiblyUnboundVariable = false # Covered by other linters.
reportPrivateImportUsage = false      # Covered by other linters.
reportPrivateUsage = false            # Covered by other linters.
reportSelfClsParameterName = false    # Too opinionated.
reportUnknownArgumentType = true
reportUnknownLambdaType = true
reportUnknownMemberType = true
reportUnknownParameterType = true
reportUnknownVariableType = true
reportUnnecessaryCast = true
reportUnnecessaryComparison = true
reportUntypedBaseClass = true
reportUntypedClassDecorator = true
reportUntypedFunctionDecorator = true
reportUntypedNamedTuple = true
reportUnusedExpression = true
reportUnusedImport = false            # Covered by other linters.
reportUnusedVariable = false          # Covered by other linters.
#strict = [ 'sources' ]
stubPath = 'sources/mimeogram/_typedecls'

[tool.pytest.ini_options]
# Note: Cannot run doctests from Pytest, because Pytest tries to update '_'
#       attribute on protected modules. Instead, we use Sphinx to run doctests.
minversion = '8.1'
addopts = """--capture=no --exitfirst --quiet -rfE -m 'not slow'""" # TODO? '--fail-under'
testpaths = [ 'tests' ]
python_files = [ 'test_*.py' ]
python_functions = [ 'test_[0-9][0-9][0-9]_*' ]
cache_dir = '.auxiliary/caches/pytest'
markers = [
    "slow: long-running tests",
]

[tool.ruff]
#builtins = [ 'ic' ]
cache-dir = '.auxiliary/caches/ruff'
extend-exclude = [ 'vulturefood.py' ]
indent-width = 4
line-length = 79
[tool.ruff.lint]
dummy-variable-rgx = '^_$'
ignore = [
  'E701',     # multiple-statements-on-one-line-colon
  'PLC0415',  # import-outside-top-level
  'SIM300',   # yoda-condition: scarred by assignment expressions, I am
]
select = [ # default: E4, E7, E9, F
  'A',        # Flake8 builtins rules
  'B006',     # mutable-argument-default
  'B008',     # function-call-in-default-argument
  'B011',     # assert-false
  'B023',     # function-uses-loop-variable
  'B904',     # raise-without-from-inside-except
  'B909',     # PREVIEW: loop-iterator-mutation
  'C90',      # McCabe complexity rules
  'E101',     # mixed-spaces-and-tabs
  'E111',     # PREVIEW: indentation-with-invalid-multiple
  'E112',     # PREVIEW: no-indented-block
  'E4',       # Pycodestyle import rules
  'E501',     # line-too-long
  'E7',       # Pycodestyle general rules
  'E9',       # Pycodestyle runtime errors
  'F',        # Pyflakes rules
  'PERF',     # Perflint rules
  'PLC',      # Pylint convention rules
  'PLE',      # Pylint error rules
  'PLR',      # Pylint refactor rules
  'PLW',      # Pylint warning rules
  'RET',      # Flake8 return rules
  'RUF',      # Ruff rules
  'S',        # Flake8 Bandit rules
  'SIM',      # Flake8 simplify rules
  'SLF',      # Flake8 self rules
  'TRY',      # Tryceratops rules
]
[tool.ruff.lint.mccabe]
max-complexity = 12
[tool.ruff.lint.per-file-ignores]
'__init__.py' = [
  'F401',     # unused-import
  'F403',     # undefined-local-with-import-star
  'F405',     # undefined-local-with-import-star-usage
]
'tests/**/*.py' = [
  'PLR0124',  # comparison-with-itself
  'PLR0913',  # too-many-arguments
  'PLR0915',  # too-many-statements
  'PLR1704',  # redefined-argument-from-local
  'PLR2004',  # magic-value-comparison
  'PLW0129',  # assert-on-string-literal
  'PLW0603',  # global-statement
  'PLW0642',  # self-assignment
  'S101',     # assert
  'SLF001',   # private-member-accessed
  'TRY',      # Tryceratops rules
]
[tool.ruff.lint.pylint]
max-locals = 10
max-public-methods = 10
max-statements = 30

[tool.towncrier]
directory = '.auxiliary/data/towncrier'
filename = 'documentation/changelog.rst'
package = 'mimeogram'
package_dir = 'sources'
[[tool.towncrier.type]]
# features and other improvements
directory = 'enhance'
name = 'Enhancements'
showcontent = true
[[tool.towncrier.type]]
# deprecations and other notices
directory = 'notify'
name = 'Notices'
showcontent = true
[[tool.towncrier.type]]
# removals of feature or platform support
directory = 'remove'
name = 'Removals'
showcontent = true
[[tool.towncrier.type]]
# bug fixes
directory = 'repair'
name = 'Repairs'
showcontent = true

[tool.vibelinter]
context = 3
exclude_paths = [ '.auxiliary/**', '.venv/**', 'tests/**',  ]

[tool.vulture]
paths = [ '.auxiliary/configuration/vulturefood.py', 'sources' ]
min_confidence = 60
exclude = [
  '*/imports.py',
]
ignore_decorators = [ '@__.abc.abstractmethod', '@__.typx.overload' ]
ignore_names = [ 'main' ]