pyproject.toml

[project]
name = "notewise"
version = "1.4.3"
description = "A terminal-native CLI that turns YouTube videos and playlists into hierarchical Markdown study notes, quizzes, transcripts, and multi-format exports (MD · HTML · PDF · DOCX) — through the LLM provider you already pay for."
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.11"
license = { file = "LICENSE" }
authors = [{ name = "Jaydeep Solanki", email = "contactjaydeepsolanki@gmail.com" }]
keywords = [
    # Core identity
    "youtube",
    "youtube-cli",
    "youtube-to-notes",
    "youtube-transcript",
    "youtube-playlist",
    # Use-case
    "study",
    "study-notes",
    "study-guide",
    "study-cli",
    "note-taking",
    "lecture-notes",
    "course-notes",
    "academic",
    # Features
    "quiz",
    "chapter-detection",
    "transcript",
    "transcription",
    "summarization",
    "batch-processing",
    # Output formats
    "markdown",
    "pdf",
    "docx",
    "html",
    # AI / LLM
    "ai",
    "ai-notes",
    "llm",
    "litellm",
    "gemini",
    "openai",
    "anthropic",
    "groq",
    # Tech
    "cli",
    "async",
    "education",
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Education",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: Developers",
    "Environment :: Console",
    "Framework :: AsyncIO",
    "License :: Other/Proprietary License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Education",
    "Topic :: Internet",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Text Processing",
    "Topic :: Text Processing :: Markup :: Markdown",
    "Topic :: Text Processing :: Linguistic",
    "Topic :: Utilities",
    "Topic :: Multimedia :: Video",
    "Typing :: Typed",
]
dependencies = [
    "litellm==1.83.14",
    "typer>=0.21.1,<0.24.0",  # 0.24.0 bumped click req to >=8.2.1; litellm pins click==8.1.8
    "rich>=15.0.0",
    "aiolimiter>=1.2.1",
    "sqlalchemy>=2.0.49",
    "pydantic>=2.12.5",     # floor set by litellm==1.83.14's exact pydantic pin
    "pydantic-settings>=2.14.1",
    "structlog>=25.5.0",
    "markdown>=3.10.2",
    "html2docx>=1.6.0",
    "python-docx>=1.2.0",
    "fpdf2>=2.8.7",
    "defusedxml>=0.7.1",
]

[project.urls]
Homepage       = "https://notewise.click"
Documentation  = "https://notewise.click/docs"
Repository     = "https://github.com/whoisjayd/notewise"
"Bug Tracker"  = "https://github.com/whoisjayd/notewise/issues"
Changelog      = "https://github.com/whoisjayd/notewise/releases"
"Docker Image" = "https://ghcr.io/whoisjayd/notewise"

[project.scripts]
notewise = "notewise.__main__:main"

# ---------------------------------------------------------------------------
# Build
# ---------------------------------------------------------------------------

[build-system]
requires      = ["hatchling>=1.29.0"]
build-backend = "hatchling.build"

[tool.hatch.metadata]
# Disallow PEP 440 direct references (url = "git+…") in published builds.
allow-direct-references = false

[tool.hatch.build.targets.wheel]
packages = ["src/notewise"]

[tool.hatch.build.targets.sdist]
include = [
    "/src",
    "/tests",
    "/README.md",
    "/LICENSE",
    "/CONTRIBUTING.md",
    "/pyproject.toml",
]

# ---------------------------------------------------------------------------
# Dev dependencies
# ---------------------------------------------------------------------------

[dependency-groups]
dev = [
    "pre-commit>=4.6.0",
    "pyinstaller>=6.20.0",
    "pytest>=9.0.3",
    "pytest-xdist>=3.8.0",
    "pytest-cov>=7.1.0",
    "pytest-asyncio>=1.3.0",
    "pytest-mock>=3.15.1",
    "ruff>=0.15.12",
    "bandit[toml]>=1.9.4",
    "deptry>=0.25.1",
    "ty>=0.0.35,<1",
    "pytest-vcr>=1.0.2",
]

# ---------------------------------------------------------------------------
# Ruff
# ---------------------------------------------------------------------------

[tool.ruff]
line-length    = 88
target-version = "py311"
src            = ["src", "tests", "scripts"]
unsafe-fixes   = true

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "F",   # pyflakes
    "B",   # flake8-bugbear
    "C4",  # flake8-comprehensions  — unnecessary list/dict/set calls
    "I",   # isort
    "UP",  # pyupgrade
    "ARG", # flake8-unused-arguments
    "PTH", # flake8-use-pathlib
    "RUF", # Ruff-specific rules    — modernisation + correctness
    "SIM", # flake8-simplify
    "TCH", # flake8-type-checking   — defer type-only imports into TYPE_CHECKING
]
ignore = [
    "RUF012", # mutable class-var annotations — expected with Pydantic models
]
per-file-ignores = { "src/notewise/cli/_banner.py" = ["E501"], "src/notewise/storage/schemas.py" = ["TC003"], "tests/**/*.py" = ["ARG001", "ARG002", "RUF003"] }

[tool.ruff.lint.isort]
known-first-party   = ["notewise"]
force-single-line   = false
lines-after-imports = 2
section-order = [
    "future",
    "standard-library",
    "third-party",
    "first-party",
    "local-folder",
]

[tool.ruff.format]
quote-style               = "double"
indent-style              = "space"
skip-magic-trailing-comma = false
line-ending               = "auto"

# ---------------------------------------------------------------------------
# ty  (Astral type-checker)
# ---------------------------------------------------------------------------

[tool.ty.environment]
python-version = "3.11"
root           = ["./src"]

[tool.ty.src]
include = ["src/notewise"]

# ---------------------------------------------------------------------------
# pytest
# ---------------------------------------------------------------------------

[tool.pytest.ini_options]
addopts                            = "-ra --tb=short"
asyncio_mode                       = "auto"
asyncio_default_fixture_loop_scope = "function"
testpaths                          = ["tests"]
python_files                       = "test_*.py"
python_classes                     = "Test*"
python_functions                   = "test_*"

# ---------------------------------------------------------------------------
# Coverage
# ---------------------------------------------------------------------------

[tool.coverage.run]
source      = ["src/notewise"]
omit        = ["*/tests/*", "*/__pycache__/*"]
concurrency = ["thread"]
branch      = true

[tool.coverage.report]
show_missing = true
skip_empty   = true
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "@(abc\\.)?abstractmethod",
]

[tool.coverage.paths]
# Map installed / CI paths back to the local source tree so that coverage
# reports merge correctly when running against an editable install.
source = [
    "src/notewise",
    "*/notewise/src/notewise",
]

# ---------------------------------------------------------------------------
# Bandit
# ---------------------------------------------------------------------------

[tool.bandit]
exclude_dirs = ["tests", "scripts"]
# MEDIUM/MEDIUM catches real issues without too much noise.
# The previous HIGH/HIGH silently skipped a broad class of findings.
severity   = "MEDIUM"
confidence = "MEDIUM"

# ---------------------------------------------------------------------------
# deptry
# ---------------------------------------------------------------------------

[tool.deptry]
exclude = [
    ".venv",
    "build",
    "dist",
    "scripts",
    "tests",
]