roadmap-cli 0.1.1__tar.gz → 0.3.0__tar.gz

{roadmap_cli-0.1.1 → roadmap_cli-0.3.0}/.gitignore

@@ -176,6 +176,7 @@ Thumbs.db
 # Roadmap local data and backups
 .roadmap/backups/
 .roadmap/artifacts/
+.roadmap/db/
 .roadmap/logs/
 .roadmap/*.local  # User-specific local overrides (not to be shared)
 .roadmap/config.yaml.local  # User settings override file (gitignored)
@@ -253,6 +254,7 @@ test_sync_init/*.lock
 /tmp/test_check_sync/*.tmp
 /tmp/test_check_sync/*.lock
 sync_git_state.txt
+/output.txt
 
 # design notes, AI prompts, etc.
 

roadmap_cli-0.3.0/CHANGELOG.md

@@ -0,0 +1,118 @@
+# Changelog
+
+All notable changes to Roadmap CLI are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases follow
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.0] - 2026-09-02
+
+### Changed
+
+- Migrated static type checking from Pyright-only to `ty` running alongside
+  Pyright, both enforced in CI and pre-commit; aligned their configured
+  Python-version floor with the declared `>=3.12` support range.
+- Reduced cyclomatic complexity across the codebase and enforced a
+  xenon B-or-better gate (absolute, per-module, and average) in CI and
+  pre-commit.
+- Raised the enforced test coverage floor from 78% to 85%, backed by a
+  targeted test-coverage sweep (CLI output formatting and issue query
+  presentation) that reached 85.70%.
+- Reduced DRY violations identified during the complexity-reduction pass.
+- Enabled GitHub's native Dependabot vulnerability alerts for the repository.
+
+### Fixed
+
+- Removed the stale, inaccurate `.env.production` file (unverifiable "0 known
+  CVEs" claim, an obsolete `poetry install` reference, and unused
+  environment variables that nothing in the codebase reads).
+- Removed the stale, tracked `output.txt` pytest-output artifact from version
+  control.
+- Fixed a broken `SECURITY.md` reference to a nonexistent developer-notes
+  file; it now points to the ADR that documents credential handling.
+
+### Removed
+
+- Removed `.env.production` and `output.txt` from version control (see
+  Fixed, above).
+
+## [0.2.0] - 2026-08-27
+
+
+### Added
+
+- Added explicit `roadmap migrate` preflight, dry-run, confirmed execution,
+  structured output, recovery, and idempotent rerun for supported 0.1.1
+  workspaces.
+- Added versioned workspace/document schemas, stable entity IDs, scoped
+  configuration, deterministic JSON/CSV output, read-only health diagnosis,
+  previewable repair, and explicit local Git status/branch/reference commands.
+- Added architecture, test-quality, package-installation, compatibility,
+  failure-injection, concurrency, corruption, migration, offline, and measured
+  performance gates.
+
+### Changed
+
+- Canonical Markdown/YAML documents are now the sole data authority. SQLite is
+  a disposable query projection refreshed or rebuilt only from those files.
+- Projects, milestones, and issues use flat stable-ID paths. Lifecycle state is
+  metadata rather than a physical archive-directory contract.
+- New IDs use complete UUID4 values; migration preserves existing IDs and
+  user-authored content.
+- The package now has one Domain/Application/Adapters/Bootstrap architecture,
+  one configuration path, one persistence path, and one implementation for
+  each retained CLI journey.
+- Supported runtimes now include Python 3.12 through 3.14 on macOS and Linux;
+  CI verifies the full Python range and installed artifacts on Ubuntu x64 and
+  macOS ARM64.
+- Machine-readable stdout is isolated from diagnostics and confirmations on
+  stderr.
+
+### Removed
+
+- Removed provider-backed synchronization, GitHub entity replication,
+  Roadmap-owned credentials, connectivity/setup handlers, provider baselines,
+  reconciliation databases, and sync metrics. Ordinary Git transport remains
+  outside Roadmap and local file-to-SQLite projection maintenance remains.
+- Removed the legacy `core`, `common`, `infrastructure`, `presentation`, and
+  superseded adapter ownership zones, along with duplicate configuration,
+  health, export, persistence, and compatibility implementations.
+- Removed claimed features that did not belong to the retained product,
+  including hosted dashboards, predictive analytics, OAuth, and generated API
+  documentation stacks.
+
+### Migration
+
+- Existing 0.1.1 workspaces must run `roadmap migrate --dry-run` and review the
+  report before `roadmap migrate --yes`.
+- Migration rewrites canonical entities to stable paths, externalizes user
+  preferences, removes legacy credential fields, and rebuilds SQLite without
+  treating it as authority. See `docs/user_guide/MIGRATING_TO_0_2.md`.
+
+## [0.1.1] - 2026-08-09
+
+### Fixed
+
+- Removed the unrelated `roadmap` PyPI distribution from runtime dependencies;
+  it shadowed this project's package and broke the console command.
+- Moved development and documentation tooling out of runtime dependencies.
+- Read the installed version from distribution metadata and added clean wheel
+  and source-distribution smoke tests.
+- Corrected supported Python/platform declarations, repository URLs, and
+  installation guidance.
+
+## [0.1.0] - 2026-05-18
+
+### Changed
+
+- Reset the public version from premature 1.x tags to 0.1.0 so package versions
+  accurately communicate pre-1.0 compatibility and maturity.
+
+## Pre-reset 1.x tags
+
+Tags numbered 1.0.0 through 1.0.2 predated the maturity reset. Their release
+notes contained aspirational and unverified feature, compatibility, coverage,
+security, and performance claims, so they are not a description of the current
+product contract. Git history remains available for provenance; supported
+behavior begins with the honest 0.1.x line above.

roadmap_cli-0.3.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.5
+Name: roadmap-cli
+Version: 0.3.0
+Summary: Git-native command line tool for local project roadmap management
+Project-URL: Homepage, https://github.com/shanewilkins/roadmap
+Project-URL: Repository, https://github.com/shanewilkins/roadmap
+Project-URL: Issues, https://github.com/shanewilkins/roadmap/issues
+Project-URL: Documentation, https://github.com/shanewilkins/roadmap/tree/main/docs
+Author: Shane Wilkins
+License: MIT
+License-File: LICENSE.md
+Keywords: cli,git,issue-tracking,milestone,offline,planning,productivity,project-management,roadmap
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Topic :: Software Development :: Bug Tracking
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Utilities
+Requires-Python: <4.0,>=3.12
+Requires-Dist: click<9.0.0,>=8.4.0
+Requires-Dist: pyyaml<7.0.0,>=6.0.3
+Requires-Dist: rich<16.0.0,>=15.0.0
+Provides-Extra: dev
+Requires-Dist: bandit[toml]>=1.9.4; extra == 'dev'
+Requires-Dist: pre-commit>=4.6.0; extra == 'dev'
+Requires-Dist: pyright>=1.1.411; extra == 'dev'
+Requires-Dist: pytest-aiohttp>=1.1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
+Requires-Dist: pytest-benchmark>=5.2.3; extra == 'dev'
+Requires-Dist: pytest-cov>=7.1.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.15.1; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
+Requires-Dist: pytest>=9.0.3; extra == 'dev'
+Requires-Dist: radon<7.0.0,>=6.0.1; extra == 'dev'
+Requires-Dist: ruff==0.16.5; extra == 'dev'
+Requires-Dist: ty>=0.0.77; extra == 'dev'
+Requires-Dist: xenon<1.0.0,>=0.9.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Roadmap CLI
+
+Roadmap is a repository-local project-management CLI for developers who want
+their planning data in reviewable Markdown and YAML files rather than a hosted
+service. It supports issues, dependencies, comments, projects, milestones,
+daily views, health checks, and machine-readable exports.
+
+The current release is 0.3.0. Its deliberately contracted behavior is defined
+by an explicit
+[public compatibility contract](docs/architecture/public-contract-0.2.md).
+0.3 is an internal quality-hardening release; the 0.2 CLI and data contract is
+unchanged.
+
+## What it does
+
+- Stores canonical project data under `.roadmap/` so it can be reviewed and
+  versioned with the repository.
+- Works offline after installation; no Roadmap account or server is required.
+- Manages issue state, priority, assignment, dependencies, progress, and
+  threaded comments.
+- Organizes work into projects and milestones and derives planning views.
+- Exposes JSON and CSV for scripts alongside human-readable terminal output.
+- Uses a local SQLite index as a rebuildable projection of canonical files.
+- Leaves network collaboration to ordinary Git.
+
+Roadmap is intentionally repository-scoped and CLI-first. It does not provide
+a hosted web UI, cross-repository portfolio planning, or provider-owned remote
+issue synchronization.
+
+## Requirements
+
+- Python 3.12, 3.13, or 3.14
+- macOS or Linux; CI tests Ubuntu 24.04 x64 and macOS 15 ARM64
+- Git when the `.roadmap/` data will be shared with collaborators
+
+## Installation
+
+With `uv`:
+
+```bash
+uv tool install roadmap-cli
+roadmap --version
+```
+
+With `pipx`:
+
+```bash
+pipx install roadmap-cli
+roadmap --version
+```
+
+Or in a virtual environment:
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install roadmap-cli
+roadmap --version
+```
+
+For development:
+
+```bash
+git clone https://github.com/shanewilkins/roadmap.git
+cd roadmap
+uv sync --all-extras --locked
+uv run roadmap --help
+```
+
+## Quick start
+
+Initialize a repository and create work:
+
+```bash
+cd my-project
+roadmap init --project-name "My project"
+roadmap issue create --title "Fix login timeout" --priority high
+roadmap issue list
+```
+
+Use the ID printed by `issue create` to inspect and update the issue:
+
+```bash
+roadmap issue view <issue-id>
+roadmap issue update <issue-id> --status in-progress
+roadmap issue progress <issue-id> 50
+roadmap issue comment add <issue-id> "Reproduced and isolated the cause."
+roadmap issue close <issue-id> --reason "Fixed and verified"
+```
+
+Organize delivery:
+
+```bash
+roadmap project create --title "Web application"
+roadmap milestone create --title "0.2" --due-date 2026-09-30
+roadmap milestone assign <issue-id> "0.2"
+roadmap milestone view "0.2"
+```
+
+Query or export data:
+
+```bash
+roadmap today
+roadmap status --format json
+roadmap issue list --status blocked --format json
+roadmap data export --format csv --output roadmap.csv
+roadmap health --format json
+```
+
+Run `roadmap <command> --help` for the exact options supported by the installed
+version.
+
+## Migrating an existing workspace
+
+The 0.2 development line upgrades 0.1.1 workspaces explicitly. Preview the
+complete validated write set first, then confirm the migration:
+
+```bash
+roadmap migrate --dry-run
+roadmap migrate --yes
+```
+
+Migration preserves existing IDs and user-authored content, moves canonical
+documents to flat stable-ID paths, externalizes user preferences, and rebuilds
+SQLite from canonical files. Resolve every reported conflict before retrying;
+ordinary reads never migrate files automatically. Follow the complete
+[0.2 migration guide](docs/user_guide/MIGRATING_TO_0_2.md) before upgrading.
+
+## Collaborating through Git
+
+Roadmap data is shared the same way as source code:
+
+```bash
+git add .roadmap/
+git commit -m "Update project roadmap"
+git pull --rebase
+git push
+```
+
+Roadmap 0.2 keeps explicit local Git conveniences such as `roadmap git status`,
+`roadmap git branch <issue-id>`, and `roadmap git link <issue-id>`. It does not
+install hooks, interpret commit prose to mutate issue state, store provider
+credentials, or synchronize directly with GitHub or another issue service.
+
+The 0.2 codebase removes the experimental 0.1.1 remote-sync, provider, and
+automatic-hook commands. Use normal Git commands for collaboration. See the
+[0.2 removal guide](docs/user_guide/REMOTE_SYNC_REMOVAL_0_2.md) before upgrading
+an existing workspace.
+
+## Data ownership and recovery
+
+Canonical Markdown and YAML are the durable data. SQLite is a local search and
+validation projection, not a second source of truth and not a remote sync
+target. Projection rebuild and canonical-file recovery are explicit and
+testable.
+
+Keep `.roadmap/` versioned and make a normal Git commit before running the 0.2
+migration. Do not treat the internal SQLite schema as a public API.
+
+## Documentation
+
+- [Quick start](docs/user_guide/QUICK_START.md)
+- [Installation](docs/user_guide/INSTALLATION.md)
+- [Workflows](docs/user_guide/WORKFLOWS.md)
+- [FAQ](docs/user_guide/FAQ.md)
+- [0.2 migration guide](docs/user_guide/MIGRATING_TO_0_2.md)
+- [Architecture decisions](docs/architecture/README.md)
+- [Refactor case study](docs/architecture/portfolio-case-study.md)
+- [0.2 release checklist](docs/releases/0.2.0-checklist.md)
+- [Requirements register](docs/requirements/README.md)
+- [Project governance](docs/governance/README.md)
+- [Security policy](SECURITY.md)
+- [Contributing guide](CONTRIBUTING.md)
+
+The old GitHub and milestone synchronization guides describe experimental
+0.1.1 behavior and are retained only as migration history; they are not the 0.2
+product direction.
+
+## Project status
+
+Roadmap 0.2.0 is the result of thirteen independently verified refactor phases.
+See the
+[execution plan](docs/architecture/refactor-execution-plan.md) and published
+[checkpoint reports](docs/architecture/README.md#execution-checkpoints).
+
+## License
+
+[MIT](LICENSE.md)

roadmap_cli-0.3.0/README.md

@@ -0,0 +1,188 @@
+# Roadmap CLI
+
+Roadmap is a repository-local project-management CLI for developers who want
+their planning data in reviewable Markdown and YAML files rather than a hosted
+service. It supports issues, dependencies, comments, projects, milestones,
+daily views, health checks, and machine-readable exports.
+
+The current release is 0.3.0. Its deliberately contracted behavior is defined
+by an explicit
+[public compatibility contract](docs/architecture/public-contract-0.2.md).
+0.3 is an internal quality-hardening release; the 0.2 CLI and data contract is
+unchanged.
+
+## What it does
+
+- Stores canonical project data under `.roadmap/` so it can be reviewed and
+  versioned with the repository.
+- Works offline after installation; no Roadmap account or server is required.
+- Manages issue state, priority, assignment, dependencies, progress, and
+  threaded comments.
+- Organizes work into projects and milestones and derives planning views.
+- Exposes JSON and CSV for scripts alongside human-readable terminal output.
+- Uses a local SQLite index as a rebuildable projection of canonical files.
+- Leaves network collaboration to ordinary Git.
+
+Roadmap is intentionally repository-scoped and CLI-first. It does not provide
+a hosted web UI, cross-repository portfolio planning, or provider-owned remote
+issue synchronization.
+
+## Requirements
+
+- Python 3.12, 3.13, or 3.14
+- macOS or Linux; CI tests Ubuntu 24.04 x64 and macOS 15 ARM64
+- Git when the `.roadmap/` data will be shared with collaborators
+
+## Installation
+
+With `uv`:
+
+```bash
+uv tool install roadmap-cli
+roadmap --version
+```
+
+With `pipx`:
+
+```bash
+pipx install roadmap-cli
+roadmap --version
+```
+
+Or in a virtual environment:
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install roadmap-cli
+roadmap --version
+```
+
+For development:
+
+```bash
+git clone https://github.com/shanewilkins/roadmap.git
+cd roadmap
+uv sync --all-extras --locked
+uv run roadmap --help
+```
+
+## Quick start
+
+Initialize a repository and create work:
+
+```bash
+cd my-project
+roadmap init --project-name "My project"
+roadmap issue create --title "Fix login timeout" --priority high
+roadmap issue list
+```
+
+Use the ID printed by `issue create` to inspect and update the issue:
+
+```bash
+roadmap issue view <issue-id>
+roadmap issue update <issue-id> --status in-progress
+roadmap issue progress <issue-id> 50
+roadmap issue comment add <issue-id> "Reproduced and isolated the cause."
+roadmap issue close <issue-id> --reason "Fixed and verified"
+```
+
+Organize delivery:
+
+```bash
+roadmap project create --title "Web application"
+roadmap milestone create --title "0.2" --due-date 2026-09-30
+roadmap milestone assign <issue-id> "0.2"
+roadmap milestone view "0.2"
+```
+
+Query or export data:
+
+```bash
+roadmap today
+roadmap status --format json
+roadmap issue list --status blocked --format json
+roadmap data export --format csv --output roadmap.csv
+roadmap health --format json
+```
+
+Run `roadmap <command> --help` for the exact options supported by the installed
+version.
+
+## Migrating an existing workspace
+
+The 0.2 development line upgrades 0.1.1 workspaces explicitly. Preview the
+complete validated write set first, then confirm the migration:
+
+```bash
+roadmap migrate --dry-run
+roadmap migrate --yes
+```
+
+Migration preserves existing IDs and user-authored content, moves canonical
+documents to flat stable-ID paths, externalizes user preferences, and rebuilds
+SQLite from canonical files. Resolve every reported conflict before retrying;
+ordinary reads never migrate files automatically. Follow the complete
+[0.2 migration guide](docs/user_guide/MIGRATING_TO_0_2.md) before upgrading.
+
+## Collaborating through Git
+
+Roadmap data is shared the same way as source code:
+
+```bash
+git add .roadmap/
+git commit -m "Update project roadmap"
+git pull --rebase
+git push
+```
+
+Roadmap 0.2 keeps explicit local Git conveniences such as `roadmap git status`,
+`roadmap git branch <issue-id>`, and `roadmap git link <issue-id>`. It does not
+install hooks, interpret commit prose to mutate issue state, store provider
+credentials, or synchronize directly with GitHub or another issue service.
+
+The 0.2 codebase removes the experimental 0.1.1 remote-sync, provider, and
+automatic-hook commands. Use normal Git commands for collaboration. See the
+[0.2 removal guide](docs/user_guide/REMOTE_SYNC_REMOVAL_0_2.md) before upgrading
+an existing workspace.
+
+## Data ownership and recovery
+
+Canonical Markdown and YAML are the durable data. SQLite is a local search and
+validation projection, not a second source of truth and not a remote sync
+target. Projection rebuild and canonical-file recovery are explicit and
+testable.
+
+Keep `.roadmap/` versioned and make a normal Git commit before running the 0.2
+migration. Do not treat the internal SQLite schema as a public API.
+
+## Documentation
+
+- [Quick start](docs/user_guide/QUICK_START.md)
+- [Installation](docs/user_guide/INSTALLATION.md)
+- [Workflows](docs/user_guide/WORKFLOWS.md)
+- [FAQ](docs/user_guide/FAQ.md)
+- [0.2 migration guide](docs/user_guide/MIGRATING_TO_0_2.md)
+- [Architecture decisions](docs/architecture/README.md)
+- [Refactor case study](docs/architecture/portfolio-case-study.md)
+- [0.2 release checklist](docs/releases/0.2.0-checklist.md)
+- [Requirements register](docs/requirements/README.md)
+- [Project governance](docs/governance/README.md)
+- [Security policy](SECURITY.md)
+- [Contributing guide](CONTRIBUTING.md)
+
+The old GitHub and milestone synchronization guides describe experimental
+0.1.1 behavior and are retained only as migration history; they are not the 0.2
+product direction.
+
+## Project status
+
+Roadmap 0.2.0 is the result of thirteen independently verified refactor phases.
+See the
+[execution plan](docs/architecture/refactor-execution-plan.md) and published
+[checkpoint reports](docs/architecture/README.md#execution-checkpoints).
+
+## License
+
+[MIT](LICENSE.md)