Skip to main content

Documentation Index

Fetch the complete documentation index at: https://notewise.click/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use uv for local development. The package uses a src layout and exposes notewise = notewise.__main__:main.

​
Setup

uv sync --dev
make hooks-install
uv run notewise version

​
Important paths

PathPurpose
src/notewise/cli/app.pyTyper command surface. Heavy imports stay lazy inside command bodies.
src/notewise/_constants.pyNumeric and string defaults.
src/notewise/config.pyPydantic settings, config file parsing, state paths.
src/notewise/errors.pyAll custom exceptions.
src/notewise/logging.pyLogging configuration and redaction.
src/notewise/pipeline/core.pyPipeline entry point.
src/notewise/pipeline/_execution.pyProcessing flow.
src/notewise/storage/SQLite models, repository, and hand-rolled migrations.
src/notewise/domain/Pure domain objects. No network or disk I/O.
scripts/make_help.pyRenders grouped make help output from Makefile ## comments.

​
Tests and checks

make test
make test-unit
make test-integration
make quality
make ci
make help is generated from Makefile comments, so target descriptions should be updated in the target line itself instead of duplicated in a manual help block. Coverage must stay at or above 90%.

​
Source invariants

RuleWhy it exists
Constants in _constants.pyKeeps defaults discoverable and testable.
Exceptions in errors.pyKeeps user-facing failure behavior consistent.
Logging only in logging.pyKeeps redaction and session logs centralized.
Lazy CLI importsKeeps startup fast and help output lightweight.
No I/O in domain/Keeps value objects pure.
No secrets in tests or docsPrevents credential leakage.

​
Release facts

Release workflows build Python distributions, PyInstaller standalone binaries, and Docker images. The GHCR image is multi-arch for linux/amd64 and linux/arm64.
Last modified on May 1, 2026