1- <!-- code2docs:start --> # planfile
1+ <!-- code2docs:start --> # strategy
22
33![ version] ( https://img.shields.io/badge/version-0.1.0-blue ) ![ python] ( https://img.shields.io/badge/python-%3E%3D3.10-blue ) ![ coverage] ( https://img.shields.io/badge/coverage-unknown-lightgrey ) ![ functions] ( https://img.shields.io/badge/functions-90-green )
44> ** 90** functions | ** 19** classes | ** 22** files | CC̄ = 5.4
77
88** Author:** Tom Sapletta
99** License:** Apache-2.0[ (LICENSE)] ( ./LICENSE )
10- ** Repository:** [ https://github.com/semcod/planfile ] ( https://github.com/semcod/planfile )
10+ ** Repository:** [ https://github.com/semcod/strategy ] ( https://github.com/semcod/strategy )
1111
1212## Installation
1313
1414### From PyPI
1515
1616``` bash
17- pip install planfile
17+ pip install strategy
1818```
1919
2020### From Source
2121
2222``` bash
23- git clone https://github.com/semcod/planfile
24- cd planfile
23+ git clone https://github.com/semcod/strategy
24+ cd strategy
2525pip install -e .
2626```
2727
2828### Optional Extras
2929
3030``` bash
31- pip install planfile [github] # github features
32- pip install planfile [jira] # jira features
33- pip install planfile [gitlab] # gitlab features
34- pip install planfile [all] # all optional features
35- pip install planfile [dev] # development tools
31+ pip install strategy [github] # github features
32+ pip install strategy [jira] # jira features
33+ pip install strategy [gitlab] # gitlab features
34+ pip install strategy [all] # all optional features
35+ pip install strategy [dev] # development tools
3636```
3737
3838## Quick Start
@@ -41,25 +41,25 @@ pip install planfile[dev] # development tools
4141
4242``` bash
4343# Generate full documentation for your project
44- planfile ./my-project
44+ strategy ./my-project
4545
4646# Only regenerate README
47- planfile ./my-project --readme-only
47+ strategy ./my-project --readme-only
4848
4949# Preview what would be generated (no file writes)
50- planfile ./my-project --dry-run
50+ strategy ./my-project --dry-run
5151
5252# Check documentation health
53- planfile check ./my-project
53+ strategy check ./my-project
5454
5555# Sync — regenerate only changed modules
56- planfile sync ./my-project
56+ strategy sync ./my-project
5757```
5858
5959### Python API
6060
6161``` python
62- from planfile import generate_readme, generate_docs, Code2DocsConfig
62+ from strategy import generate_readme, generate_docs, Code2DocsConfig
6363
6464# Quick: generate README
6565generate_readme(" ./my-project" )
@@ -71,7 +71,7 @@ docs = generate_docs("./my-project", config=config)
7171
7272## Generated Output
7373
74- When you run ` planfile ` , the following files are produced:
74+ When you run ` strategy ` , the following files are produced:
7575
7676```
7777<project>/
@@ -94,7 +94,7 @@ When you run `planfile`, the following files are produced:
9494
9595## Configuration
9696
97- Create ` planfile .yaml` in your project root (or run ` planfile init` ):
97+ Create ` strategy .yaml` in your project root (or run ` strategy init` ):
9898
9999``` yaml
100100project :
@@ -126,7 +126,7 @@ examples:
126126 from_entry_points : true
127127
128128sync :
129- planfile : markers # markers | full | git-diff
129+ strategy : markers # markers | full | git-diff
130130 watch : false
131131 ignore :
132132 - " tests/"
@@ -135,22 +135,22 @@ sync:
135135
136136## Sync Markers
137137
138- planfile can update only specific sections of an existing README using HTML comment markers:
138+ strategy can update only specific sections of an existing README using HTML comment markers:
139139
140140` ` ` markdown
141- <!-- planfile :start -->
141+ <!-- strategy :start -->
142142# Project Title
143143... auto-generated content ...
144- <!-- planfile :end -->
144+ <!-- strategy :end -->
145145```
146146
147147Content outside the markers is preserved when regenerating. Enable this with ` sync_markers: true ` in your configuration.
148148
149149## Architecture
150150
151151```
152- planfile /
153- ├── planfile/ ├── runner ├── yaml_loader ├── loaders/ ├── cli_loader ├── auto_loop ├── cli/ ├── __main__ ├── priorities ├── utils/ ├── metrics ├── commands ├── integrations/ ├── gitlab ├── jira ├── github ├── generic├── docker-entrypoint├── project ├── ci_runner ├── models ├── base```
152+ strategy /
153+ ├── planfile/ ├── yaml_loader ├── cli_loader ├── loaders/ ├── runner ├── auto_loop ├── cli/ ├── __main__ ├── priorities ├── utils/ ├── commands ├── metrics ├── integrations/ ├── gitlab ├── jira ├── github ├── generic├── docker-entrypoint├── project ├── ci_runner ├── models ├── base```
154154
155155## API Overview
156156
@@ -178,8 +178,6 @@ planfile/
178178
179179### Functions
180180
181- - `apply_strategy(strategy, project_path, backends, backend_name)` — Apply a strategy to create/update tickets.
182- - `review_strategy(strategy, project_path, backends, backend_name)` — Review strategy execution by checking ticket statuses.
183181- `load_yaml(file_path)` — Load YAML file and return as dictionary.
184182- `save_yaml(data, file_path)` — Save dictionary to YAML file.
185183- `load_strategy_yaml(file_path)` — Load strategy from YAML file.
@@ -192,19 +190,21 @@ planfile/
192190- `load_strategy_from_json(file_path)` — Load strategy from JSON file.
193191- `save_strategy_to_json(strategy, file_path)` — Save strategy to JSON file.
194192- `export_results_to_markdown(results, file_path)` — Export strategy results to Markdown file.
193+ - `apply_strategy(strategy, project_path, backends, backend_name)` — Apply a strategy to create/update tickets.
194+ - `review_strategy(strategy, project_path, backends, backend_name)` — Review strategy execution by checking ticket statuses.
195195- `get_backend(backend_type)` — Get backend instance by type.
196196- `auto_loop(strategy, project_path, backend, max_iterations)` — Run automated CI/CD loop: test → ticket → fix → retest.
197197- `ci_status(project_path)` — Check current CI status without running tests.
198198- `calculate_task_priority(base_priority, task_type, sprint_id, weight_factors)` — Calculate task priority based on type, sprint, and base priority.
199199- `map_priority_to_system(priority, system)` — Map generic priority to system-specific priority.
200200- `get_priority_color(priority)` — Get color code for priority (for UI display).
201- - `analyze_project_metrics(project_path)` — Analyze project metrics for strategy review.
202- - `calculate_strategy_health(strategy_results)` — Calculate health metrics for a strategy execution.
203201- `get_backend(backend_type, config)` — Get backend instance by type and config.
204202- `apply_strategy_cli(strategy_path, project_path, backend, config_file)` — Apply a strategy to create tickets.
205203- `review_strategy_cli(strategy_path, project_path, backend, config_file)` — Review strategy execution and progress.
206204- `validate_strategy_cli(strategy_path, verbose)` — Validate a strategy YAML file.
207205- `main()` — Main CLI entry point.
206+ - `analyze_project_metrics(project_path)` — Analyze project metrics for strategy review.
207+ - `calculate_strategy_health(strategy_results)` — Calculate health metrics for a strategy execution.
208208- `check_env()` — —
209209- `validate_config()` — —
210210- `setup_workspace()` — —
0 commit comments