SDLC automation platform - strategic project management with CI/CD integration and automated bug-fix loops
Project description
now:
before:
Planfile
Planfile is an SDLC automation platform that provides strategic project management with CI/CD integration and automated bug-fix loops. It manages sprints and strategies across external ticket systems like GitHub, Jira, and GitLab.
๐ Project Metrics
- 56 modules with 395 functions
- Cyclomatic Complexity: CCฬ=4.1 (improved from 4.2)
- Critical functions: 15 (target: โค4)
- Zero circular dependencies
- Languages: Python (53), Shell (17), JavaScript (3)
โจ Features
- ๐ฏ Strategy Modeling: Define strategies and sprints in YAML with task patterns
- ๐ Automated CI/CD Loop: Test โ Ticket โ Fix โ Retest automation
- ๐ Multi-Backend Support: Integrates with GitHub Issues, Jira, GitLab, and generic HTTP APIs
- ๐ค LLM-Powered: AI-driven bug reports and auto-fix capabilities
- ๐ Progress Tracking: Review strategy execution with detailed metrics
- ๐ CLI Tool: Easy-to-use command-line interface for applying and reviewing strategies
- ๐จ Rich Output: Beautiful terminal output with progress bars and tables
- ๐ณ Docker Support: Containerized deployment with Ollama integration
- ๐ง Extensible: Easy to add new backends and custom integrations
- ๐ Code Analysis: Integration with external tools (code2llm, vallm, redup)
- ๐ MCP Server: Model Context Protocol server integration
- ๐ค LLX Integration: Advanced code analysis and model selection
- ๐ Proxy Routing: Smart model routing via Proxym API
- ๐ Metrics-Driven: Project metrics analysis for informed planning
๐ฆ Installation
# Basic installation
pip install planfile
# With all backend integrations
pip install planfile[all]
# Or with specific backends
pip install planfile[github,jira]
pip install planfile[gitlab]
๐ Quick Start
1. Create a Strategy
Create a strategy.yaml file:
name: "My Project Strategy"
project_type: "web"
domain: "fintech"
goal: "Launch a secure payment processing platform"
sprints:
- id: 1
name: "Core Infrastructure"
length_days: 14
objectives:
- Set up project structure
- Implement authentication
tasks:
- type: "feature"
title: "Setup project structure"
description: "Create basic project layout and configuration"
estimate: 2
priority: "high"
- id: 2
name: "Payment Processing"
length_days: 21
objectives:
- Implement payment gateway
- Add security measures
tasks:
- type: "feature"
title: "Payment gateway integration"
description: "Integrate with payment provider API"
estimate: 5
priority: "critical"
2. Configure Environment
# GitHub
export GITHUB_TOKEN=your_token
export GITHUB_REPO=owner/repo
# Jira
export JIRA_URL=https://company.atlassian.net
export JIRA_EMAIL=your@email.com
export JIRA_TOKEN=your_token
export JIRA_PROJECT=PROJ
# GitLab
export GITLAB_TOKEN=your_token
export GITLAB_PROJECT_ID=123
3. Run CI/CD Auto-Loop
# Run automated bug-fix loop
planfile auto loop \
--strategy ./strategy.yaml \
--project . \
--backend github \
--max-iterations 5 \
--auto-fix
# Check CI status
planfile auto ci-status
# Review strategy progress
planfile strategy review \
--strategy ./strategy.yaml \
--project . \
--backend github
4. Using Makefile
# Run CI loop with strategy
make ci-loop STRATEGY=strategy.yaml BACKENDS=github MAX_ITERATIONS=5
# Run examples
make example-github
make example-jira
# Full pipeline
make pipeline-docker
๐ CI/CD Automation
Planfile provides complete automation for the bug-fix lifecycle:
- Test Execution: Run your test suite
- Bug Detection: Identify failing tests and code issues
- AI Analysis: Generate detailed bug reports using LLM
- Ticket Creation: Create tickets in your PM system
- Auto-Fix: Optionally fix bugs automatically with AI
- Verification: Re-run tests to verify fixes
- Loop: Repeat until all tests pass
๐ณ Docker Support
# Build Docker image
make docker-build
# Run with Docker Compose
docker-compose up -d
# Run auto-loop in container
docker-compose exec sprintstrat-runner planfile auto loop \
--strategy /app/strategy.yaml \
--project /workspace \
--backend github \
--max-iterations 5
๐ Documentation
- CI/CD Integration Guide
- API Reference
- CLI Reference
- Examples
- Architecture Overview
- Migration Guide
- Changelog
๐ง Configuration
Strategy Schema (v2)
The strategy.yaml file supports:
- Sprints: Time-boxed development periods with embedded tasks
- Goals: Project objectives with success criteria
- Quality Gates: Definition of done criteria
- Model Hints: AI model suggestions for different phases
Example Strategy (v2)
name: "My Project Strategy"
project_type: "web"
domain: "fintech"
goal:
title: "Launch secure payment platform"
description: "Build and deploy a secure payment processing system"
success_metrics:
- "99.9% uptime"
- "<100ms response time"
sprints:
- id: 1
name: "Core Infrastructure"
length_days: 14
objectives: ["Set up project structure", "Implement authentication"]
tasks:
- type: "feature"
title: "Setup project structure"
description: "Create basic project layout and configuration"
estimate: 2
priority: "high"
model_hints:
small: "gpt-4o-mini"
large: "gpt-4o"
quality_gates:
- name: "Code Coverage"
criteria: ["coverage >= 80%"]
required: true
Backend Configuration
Each backend requires specific configuration:
# GitHub backend
github:
token: ${GITHUB_TOKEN}
repo: ${GITHUB_REPO}
# Jira backend
jira:
url: ${JIRA_URL}
email: ${JIRA_EMAIL}
token: ${JIRA_TOKEN}
project: ${JIRA_PROJECT}
๐ค AI Integration
Planfile integrates with multiple LLM services:
- Multiple Providers: OpenAI, Anthropic, LiteLLM, Local LLMs
- Smart Routing: Automatic model selection via Proxym proxy
- Code Analysis: LLX integration for advanced metrics
- Auto-Fix: Automatic code generation for bug fixes
- Strategy Generation: AI-powered strategy creation
# Enable AI features
export OPENAI_API_KEY=your_key
export ANTHROPIC_API_KEY=your_key
export PROXY_API_URL=http://localhost:9999
# Run with auto-fix
planfile auto loop --strategy strategy.yaml --auto-fix
# Generate strategy with AI
planfile strategy generate ./my-project --model gpt-4o
๐ Examples
Web Project Strategy
name: "E-commerce MVP"
project_type: "web"
domain: "ecommerce"
goal: "Launch minimum viable e-commerce platform"
sprints:
- id: 1
name: "Foundation"
length_days: 10
tasks:
- type: "feature"
title: "Setup project structure"
estimate: 1
- type: "feature"
title: "Database schema"
estimate: 3
Mobile App Strategy
name: "Mobile App MVP"
project_type: "mobile"
domain: "healthcare"
goal: "Launch health tracking mobile app"
sprints:
- id: 1
name: "Core Features"
length_days: 14
tasks:
- type: "feature"
title: "User authentication"
estimate: 3
- type: "feature"
title: "Health data tracking"
estimate: 5
๐ Integrations
Version Control
- GitHub: Issues, Projects, Actions
- GitLab: Issues, CI/CD, Merge Requests
- Bitbucket: Issues, Pipelines
Project Management
- Jira: Issues, Epics, Sprints
- Linear: Issues, Projects, Teams
- ClickUp: Tasks, Lists, Spaces
- Asana: Tasks, Projects, Portfolios
CI/CD Platforms
- GitHub Actions: Workflow automation
- GitLab CI: Pipeline integration
- Jenkins: Build automation
- Azure DevOps: Release management
๐ ๏ธ Development
Setup Development Environment
# Clone repository
git clone https://github.com/semcod/strategy
cd strategy
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install in development mode
pip install -e ".[dev]"
# Run tests
pytest tests/ -v
# Run linting
ruff check src/ tests/
ruff format src/ tests/
Project Structure
planfile/
โโโ planfile/ # Main package
โ โโโ analysis/ # Code analysis components
โ โ โโโ external_tools.py # External tool integrations
โ โ โโโ generator.py # Strategy generation
โ โ โโโ file_analyzer.py # File analysis
โ โ โโโ sprint_generator.py # Sprint generation
โ โ โโโ parsers/ # YAML/JSON/Toon parsers
โ โ โโโ generators/ # Metrics extractors
โ โโโ cli/ # CLI commands
โ โ โโโ cmd/ # Core commands (init, generate, apply, etc.)
โ โ โโโ auto_loop.py # CI/CD automation
โ โ โโโ extra_commands.py # Additional utilities
โ โโโ integrations/ # Backend integrations
โ โ โโโ github.py # GitHub Issues
โ โ โโโ jira.py # Jira
โ โ โโโ gitlab.py # GitLab
โ โ โโโ generic.py # Generic HTTP API
โ โโโ llm/ # LLM integrations
โ โ โโโ adapters.py # Multiple LLM adapters
โ โ โโโ client.py # LLM client
โ โ โโโ generator.py # Strategy generation
โ โโโ loaders/ # Data loaders
โ โ โโโ yaml_loader.py # YAML loading/saving
โ โ โโโ cli_loader.py # JSON/Markdown export
โ โโโ models.py # Core data models
โ โโโ models_v2.py # Simplified models
โ โโโ runner.py # Strategy execution
โ โโโ ci_runner.py # CI/CD automation
โ โโโ executor_standalone.py # Standalone executor
โโโ examples/ # Usage examples
โ โโโ quick-start/ # Basic examples
โ โโโ ecosystem/ # Integration examples
โ โโโ advanced-usage/ # Advanced features
โโโ tests/ # Test suite
โโโ docs/ # Documentation
โโโ project/ # Project analysis output
๐ License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
๐ค Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
๐ Support
- ๐ Documentation
- ๐ Issue Tracker
- ๐ฌ Discussions
๐ Acknowledgments
- Built with Typer for CLI
- Styled with Rich for terminal output
- Validated with Pydantic for data models
Planfile - Your strategic partner in SDLC automation. ๐
License
Apache License 2.0 - see LICENSE for details.
Author
Created by Tom Sapletta - tom@sapletta.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file planfile-0.1.37.tar.gz.
File metadata
- Download URL: planfile-0.1.37.tar.gz
- Upload date:
- Size: 98.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f51b9bcd9aca1e2b69e956dd6131404b7a57d07b54bb4107a01c0b09bf671ab
|
|
| MD5 |
35e309320726143de5539898742a136d
|
|
| BLAKE2b-256 |
09e4f56c681fe337e47ad8140951f221c929b648c61362a01aaa462c0d0202b1
|
File details
Details for the file planfile-0.1.37-py3-none-any.whl.
File metadata
- Download URL: planfile-0.1.37-py3-none-any.whl
- Upload date:
- Size: 123.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f99af68d941630909433b4dbc978e187ae6a9037c2383e8f060baa988ec78e28
|
|
| MD5 |
5c123889e1f5dfb3084c20546494b156
|
|
| BLAKE2b-256 |
8cc0d156faa87b6f7c124a83e0106b0b4bb04731db348c3ea192b497fc4429a8
|