pyproject.toml

[project]
name = "pgcli"
authors = [{ name = "Pgcli Core Team", email = "pgcli-dev@googlegroups.com" }]
license = { text = "BSD" }
description = "CLI for Postgres Database. With auto-completion and syntax highlighting."
readme = "README.rst"
classifiers = [
    "Intended Audience :: Developers",
    "License :: OSI Approved :: BSD License",
    "Operating System :: Unix",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: SQL",
    "Topic :: Database",
    "Topic :: Database :: Front-Ends",
    "Topic :: Software Development",
    "Topic :: Software Development :: Libraries :: Python Modules",
]
urls = { Homepage = "https://pgcli.com" }
requires-python = ">=3.10"
dependencies = [
    "pgspecial>=2.0.0",
    "click >= 8.3.1",
    "Pygments>=2.0",       # Pygments has to be Capitalcased.
    # We still need to use pt-2 unless pt-3 released on Fedora32
    # see: https://github.com/dbcli/pgcli/pull/1197
    "prompt_toolkit>=2.0.6,<4.0.0",
    "psycopg >= 3.0.14; sys_platform != 'win32'",
    "psycopg-binary >= 3.0.14; sys_platform == 'win32'",
    "sqlparse >=0.3.0,<0.6",
    "configobj >= 5.0.6",
    "cli_helpers[styles] >= 2.4.0",
    # setproctitle is used to mask the password when running `ps` in command line.
    # But this is not necessary in Windows since the password is never shown in the
    # task manager. Also setproctitle is a hard dependency to install in Windows,
    # so we'll only install it if we're not in Windows.
    "setproctitle >= 1.1.9; sys_platform != 'win32' and 'CYGWIN' not in sys_platform",
    "tzlocal >= 5.2",
]
dynamic = ["version"]


[project.scripts]
pgcli = "pgcli.main:cli"
pgcli_dump = "pgcli.dump:cli"
pgcli_dumpall = "pgcli.dumpall:cli"
pgcli_isready = "pgcli.isready:cli"

[project.optional-dependencies]
keyring = ["keyring >= 12.2.0"]
sshtunnel = [
    "paramiko >= 3.0",
]
dev = [
    "behave>=1.2.4",
    "coverage>=7.2.7",
    "docutils>=0.13.1",
    "keyrings.alt>=3.1",
    "pexpect>=4.9.0; platform_system != 'Windows'",
    "pytest>=7.4.4",
    "pytest-cov>=4.1.0",
    "ruff>=0.11.7",
    "paramiko>=3.0",
    "tox>=1.9.2",
]

[build-system]
requires = ["setuptools>=64.0", "setuptools-scm>=8"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]

[tool.setuptools]
include-package-data = false

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

[tool.setuptools.packages]
find = { namespaces = false }

[tool.setuptools.package-data]
pgcli = ["pgclirc", "packages/pgliterals/pgliterals.json"]

[tool.ruff]
target-version = 'py310'
line-length = 140

[tool.ruff.lint]
select = [
    'A',
#   'I',      # todo enableme imports
    'E',
    'W',
    'F',
    'C4',
    'PIE',
    'TID',
]
ignore = [
    'E401',   # Multiple imports on one line
    'E402',   # Module level import not at top of file
    'PIE808', # range() starting with 0
    # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
    'E111',   # indentation-with-invalid-multiple
    'E114',   # indentation-with-invalid-multiple-comment
    'E117',   # over-indented
    'W191',   # tab-indentation
    'E741',   # ambiguous-variable-name
    # TODO
    'PIE796', # todo enableme Enum contains duplicate value
]
exclude = [
    'pgcli/magic.py',
    'pgcli/pyev.py',
]

[tool.ruff.lint.isort]
force-sort-within-sections = true
known-first-party = [
    'pgcli',
    'tests',
]

[tool.ruff.format]
preview = true
quote-style = 'preserve'
exclude = [
    'build',
]

[tool.pytest.ini_options]
minversion = "6.0"
addopts = "--capture=sys --showlocals -rxs"
testpaths = ["tests"]

[tool.mypy]
python_version = "3.10"
warn_return_any = true
warn_unused_configs = true
warn_redundant_casts = true
warn_unused_ignores = true
strict_equality = true
extra_checks = true
check_untyped_defs = true
disallow_untyped_defs = false  # Start permissive, tighten later
ignore_missing_imports = true  # For third-party libs without stubs
disable_error_code = ["import-untyped"]  # paramiko and other libs without stubs
follow_imports = "skip"  # Avoid module resolution issues with editable installs
files = ["pgcli"]
exclude = [
    "build/",
    "dist/",
    ".venv/",
    "tests/",
    "pgcli/magic.py",  # IPython-specific, uses runtime features
]

[dependency-groups]
dev = [
    "mypy>=1.19.1",
]