prompt-diary 0.1.0a1__tar.gz

prompt_diary-0.1.0a1/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.3
+Name: prompt-diary
+Version: 0.1.0a1
+Summary: Review user prompts for evidence-backed improvement in AI coding collaboration.
+Requires-Dist: typer>=0.25.1
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Prompt Diary
+
+Prompt Diary prepares bounded, redacted workspaces from local assistant session history and generates evidenced prompt diary reports that help users review and improve how they collaborate with AI coding agents.
+
+The tool targets Python 3.10 and newer. The package exposes `report` and `prompt-diary`
+console commands after installation.
+
+## Usage
+
+Install the command as an isolated uv tool:
+
+```bash
+uv tool install .
+```
+
+Then run:
+
+```bash
+report --help
+prompt-diary --help
+report prepare --date 2026-05-12 --timezone Asia/Shanghai
+report generate --date 2026-05-12 --timezone Asia/Shanghai
+```
+
+During development, `uv sync` installs the project into the local `.venv`; use `uv run` to
+execute the command from that environment:
+
+```bash
+uv run report --help
+```
+
+## Development
+
+This project uses [`uv`](https://docs.astral.sh/uv/) for Python version, environment, dependency, build, and release workflows.
+
+### Environment
+
+Set up the development environment:
+
+```bash
+uv sync
+```
+
+Run the CLI from the project environment:
+
+```bash
+uv run report --help
+```
+
+### Dependencies
+
+Add runtime dependencies with:
+
+```bash
+uv add <package>
+```
+
+Add development-only dependencies with:
+
+```bash
+uv add --dev <package>
+```
+
+### Build And Release
+
+Build source and wheel distributions:
+
+```bash
+uv build
+```
+
+Publish release artifacts only after the package metadata and target registry are configured:
+
+```bash
+uv publish
+```
+
+### Type Checking
+
+Type checking uses [`basedpyright`](https://docs.basedpyright.com/latest/configuration/command-line/). The project config enables strict mode for `src` and `tests`.
+Add type annotations by best effort for new and changed code. This is a hard rule: prefer
+explicit, checkable types whenever they improve clarity or allow basedpyright to verify behavior.
+Use accurate types when possible instead of relying on repeated validation. At module boundaries,
+parse untrusted or loosely structured inputs into precise internal types, then pass those types
+through the rest of the code. Do not validate a value and then continue passing the original
+loose representation when a richer type, dataclass, `TypedDict`, `NewType`, enum, or other
+structured representation can preserve the invariant for callers and the type checker.
+
+```bash
+uv run basedpyright
+```
+
+### Tests
+
+Tests use [`pytest`](https://docs.pytest.org/). The pytest config lives in `pyproject.toml`
+and uses strict config and marker validation.
+
+```bash
+uv run pytest
+```
+
+### Linting And Formatting
+
+Linting and formatting use [`ruff`](https://docs.astral.sh/ruff/). Ruff is configured for Python 3.10.
+The lint rule set is explicit and intentionally broader than Ruff's defaults, covering imports,
+modernization, bug-prone patterns, datetime safety, security checks, pathlib usage, pytest style,
+exception handling, and simplification rules.
+
+```bash
+uv run ruff check
+uv run ruff format --check
+uv run ruff format
+```
+
+### Pre-Submit Checks
+
+Before submitting changes, run:
+
+```bash
+uv run ruff check
+uv run ruff format --check
+uv run basedpyright
+uv run pytest
+uv build
+```

prompt_diary-0.1.0a1/README.md

@@ -0,0 +1,125 @@
+# Prompt Diary
+
+Prompt Diary prepares bounded, redacted workspaces from local assistant session history and generates evidenced prompt diary reports that help users review and improve how they collaborate with AI coding agents.
+
+The tool targets Python 3.10 and newer. The package exposes `report` and `prompt-diary`
+console commands after installation.
+
+## Usage
+
+Install the command as an isolated uv tool:
+
+```bash
+uv tool install .
+```
+
+Then run:
+
+```bash
+report --help
+prompt-diary --help
+report prepare --date 2026-05-12 --timezone Asia/Shanghai
+report generate --date 2026-05-12 --timezone Asia/Shanghai
+```
+
+During development, `uv sync` installs the project into the local `.venv`; use `uv run` to
+execute the command from that environment:
+
+```bash
+uv run report --help
+```
+
+## Development
+
+This project uses [`uv`](https://docs.astral.sh/uv/) for Python version, environment, dependency, build, and release workflows.
+
+### Environment
+
+Set up the development environment:
+
+```bash
+uv sync
+```
+
+Run the CLI from the project environment:
+
+```bash
+uv run report --help
+```
+
+### Dependencies
+
+Add runtime dependencies with:
+
+```bash
+uv add <package>
+```
+
+Add development-only dependencies with:
+
+```bash
+uv add --dev <package>
+```
+
+### Build And Release
+
+Build source and wheel distributions:
+
+```bash
+uv build
+```
+
+Publish release artifacts only after the package metadata and target registry are configured:
+
+```bash
+uv publish
+```
+
+### Type Checking
+
+Type checking uses [`basedpyright`](https://docs.basedpyright.com/latest/configuration/command-line/). The project config enables strict mode for `src` and `tests`.
+Add type annotations by best effort for new and changed code. This is a hard rule: prefer
+explicit, checkable types whenever they improve clarity or allow basedpyright to verify behavior.
+Use accurate types when possible instead of relying on repeated validation. At module boundaries,
+parse untrusted or loosely structured inputs into precise internal types, then pass those types
+through the rest of the code. Do not validate a value and then continue passing the original
+loose representation when a richer type, dataclass, `TypedDict`, `NewType`, enum, or other
+structured representation can preserve the invariant for callers and the type checker.
+
+```bash
+uv run basedpyright
+```
+
+### Tests
+
+Tests use [`pytest`](https://docs.pytest.org/). The pytest config lives in `pyproject.toml`
+and uses strict config and marker validation.
+
+```bash
+uv run pytest
+```
+
+### Linting And Formatting
+
+Linting and formatting use [`ruff`](https://docs.astral.sh/ruff/). Ruff is configured for Python 3.10.
+The lint rule set is explicit and intentionally broader than Ruff's defaults, covering imports,
+modernization, bug-prone patterns, datetime safety, security checks, pathlib usage, pytest style,
+exception handling, and simplification rules.
+
+```bash
+uv run ruff check
+uv run ruff format --check
+uv run ruff format
+```
+
+### Pre-Submit Checks
+
+Before submitting changes, run:
+
+```bash
+uv run ruff check
+uv run ruff format --check
+uv run basedpyright
+uv run pytest
+uv build
+```

prompt_diary-0.1.0a1/pyproject.toml

@@ -0,0 +1,130 @@
+[project]
+name = "prompt-diary"
+version = "0.1.0a1"
+description = "Review user prompts for evidence-backed improvement in AI coding collaboration."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "typer>=0.25.1",
+]
+
+[project.scripts]
+prompt-diary = "prompt_diary.cli:main"
+report = "prompt_diary.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.11.6,<0.12"]
+build-backend = "uv_build"
+
+[tool.basedpyright]
+include = ["src", "tests"]
+pythonVersion = "3.10"
+typeCheckingMode = "strict"
+reportMissingTypeStubs = false
+
+[tool.pytest.ini_options]
+minversion = "9.0"
+testpaths = ["tests"]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+src = ["src", "tests"]
+extend-exclude = ["export_codex_user_history.py"]
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    "W",
+    # Pyflakes
+    "F",
+    # isort
+    "I",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-unused-arguments
+    "ARG",
+    # flake8-blind-except
+    "BLE",
+    # flake8-comprehensions
+    "C4",
+    # mccabe
+    "C90",
+    # flake8-datetimez
+    "DTZ",
+    # eradicate
+    "ERA",
+    # flake8-boolean-trap
+    "FBT",
+    # flake8-logging
+    "LOG",
+    # flake8-logging-format
+    "G",
+    # flake8-no-pep420
+    "INP",
+    # pep8-naming
+    "N",
+    # Perflint
+    "PERF",
+    # flake8-pie
+    "PIE",
+    # Pylint convention, error, and warning rules.
+    "PLC",
+    "PLE",
+    "PLW",
+    # flake8-pytest-style
+    "PT",
+    # flake8-use-pathlib
+    "PTH",
+    # flake8-return
+    "RET",
+    # flake8-raise
+    "RSE",
+    # flake8-bandit
+    "S",
+    # flake8-simplify
+    "SIM",
+    # flake8-type-checking
+    "TC",
+    # flake8-tidy-imports
+    "TID",
+    # tryceratops
+    "TRY",
+    # flake8-2020
+    "YTT",
+    # Ruff-specific rules
+    "RUF",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    # Allow pytest assertions in tests.
+    "S101",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["prompt_diary"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.39.4",
+    "pytest>=9.0.3",
+    "ruff>=0.15.12",
+]

prompt_diary-0.1.0a1/src/prompt_diary/__init__.py

@@ -0,0 +1,5 @@
+"""Prompt Diary package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0a1"

prompt_diary-0.1.0a1/src/prompt_diary/cli.py

@@ -0,0 +1,68 @@
+"""Typer command-line entrypoint for Prompt Diary."""
+
+from __future__ import annotations
+
+from typing import Annotated
+
+import typer
+
+from prompt_diary import __version__
+
+app = typer.Typer(
+    add_completion=False,
+    help="Prepare and generate evidence-backed prompt diary reports.",
+    invoke_without_command=True,
+    no_args_is_help=True,
+)
+
+DateOption = Annotated[str | None, typer.Option(help="Target local date in YYYY-MM-DD format.")]
+TodayOption = Annotated[bool, typer.Option(help="Target the current local day.")]
+TimezoneOption = Annotated[
+    str | None,
+    typer.Option(help="IANA timezone name, e.g. Asia/Shanghai."),
+]
+ForceOption = Annotated[bool, typer.Option(help="Recreate an existing workspace.")]
+VersionOption = Annotated[
+    bool,
+    typer.Option("--version", help="Show the version and exit.", is_eager=True),
+]
+
+
+@app.callback()
+def app_callback(*, version: VersionOption = False) -> None:
+    """Prompt Diary command group."""
+    if version:
+        typer.echo(__version__)
+        raise typer.Exit
+
+
+@app.command()
+def prepare(
+    *,
+    date: DateOption = None,
+    today: TodayOption = False,
+    timezone: TimezoneOption = None,
+    force: ForceOption = False,
+) -> None:
+    """Prepare a prompt diary workspace."""
+    _fail_not_implemented("prepare", date, today, timezone, force)
+
+
+@app.command()
+def generate(
+    *,
+    date: DateOption = None,
+    today: TodayOption = False,
+    timezone: TimezoneOption = None,
+) -> None:
+    """Generate and validate a prompt diary report."""
+    _fail_not_implemented("generate", date, today, timezone)
+
+
+def _fail_not_implemented(command: str, *_options: object) -> None:
+    typer.echo(f"Error: {command!r} is not implemented yet", err=True)
+    raise typer.Exit(2)
+
+
+def main() -> None:
+    app()