pyproject.toml

[build-system]
requires = ["pdm-backend"]
build-backend = "pdm.backend"

[project]
name = "terminal_sync"
version = "0.3.0"
description = "A standalone tool for logging shell commands to GhostWriter automatically"
authors = [{ name = "breakid" }]
license = { text = "GPL-3.0-or-later" }
readme = "README.md"
requires-python = ">=3.10" # The type hinting used in this project follows PEP 604, which was implemented in 3.10
dependencies = [
  "aiohttp>=3.8.4",
  "fastapi>=0.95.0",
  "gql>=3.4.0",
  "python-dotenv>=1.0.0",
  "pyyaml>=6.0",
  "uvicorn>=0.21.1",
]
keywords = ["GhostWriter"]

[project.urls]
homepage = "https://github.com/breakid/terminal_sync"
documentation = "https://breakid.github.io/terminal_sync"
repository = "https://github.com/breakid/terminal_sync"

[tool.black]
line-length = 120

[tool.flake8]
# Compatibility settings for Black (see https://black.readthedocs.io/en/latest/guides/using_black_with_other_tools.html#flake8)
extend-ignore = ["E203"]
max-line-length = 120

[tool.interrogate]
exclude = ["docs", "build"]
fail-under = 90
ignore-init-method = true
ignore-init-module = true
verbose = 2

[tool.isort]
atomic = true
force_single_line = true
import_headings = { stdlib = "Standard Libraries", thirdparty = "Third-party Libraries", firstparty = "Internal Libraries" }
known_first_party = ["terminal_sync"]
line_length = 120
profile = "black"

[tool.mypy]
disable_error_code = "attr-defined"

[tool.pdm]

[tool.pdm.dev-dependencies]
dev = [
  "black>=23.3.0",
  "pytest>=7.3.0",
  "pre-commit>=3.2.2",
  "types-PyYAML>=6.0.12.9",
]
docs = ["mkdocs>=1.4.2"]

[tool.pdm.scripts]
check = "pre-commit run --all-files"
code = "code terminal_sync.code-workspace"
# Run the documentation server on 8080 so it doesn't interfere with the terminal_sync server
docs = "mkdocs serve --dev-addr 127.0.0.1:8080"
serve = "python -m terminal_sync"
test = "pytest"