workplan-ai 0.3.3
AI-powered weekly planning for professional developers
License: MIT
Requires Python: >=3.8

# Workplan AI 👊

[![PyPI version](https://img.shields.io/pypi/v/workplan-ai?style=flat-square&color=blue)](https://pypi.org/project/workplan-ai/)
[![Python versions](https://img.shields.io/pypi/pyversions/workplan-ai?style=flat-square)](https://pypi.org/project/workplan-ai/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/workplan-ai?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/workplan-ai)

**The Professional Standard for Engineer-Led Weekly Execution.**

[Official Website](https://visualvortexcreatives.vercel.app/) | [Project Dashboard](https://visualvortexcreatives.vercel.app/integrations) | [PyPI](https://pypi.org/project/workplan-ai/)

`Workplan AI` is an enterprise-grade productivity engine designed for high-performance software engineering teams. It bridges the gap between high-level roadmaps and daily execution by automating task decomposition, progress tracking via Git activity, and cross-platform reporting.

---

## 🏗️ Core Architecture: The "Clean Room" CLI
Unlike traditional AI tools that require local secrets, Workplan AI implements a **Secure Backend Proxy Architecture**:

- **Stateless CLI**: Your machine holds no integration tokens. All authentication is managed via encrypted OAuth sessions in our secure cloud vault.
- **Git-Aware Context**: Local repository analysis (`git diff`) is used exclusively to ground AI generations in your actual codebase without manual prompt engineering.
- **Bi-Directional Sync**: Monthly roadmaps, weekly plans, and daily logs are synchronized in a single unified state.

---

## 🚀 Quick Start

### 1. Installation
```bash
pip install workplan-ai
```

### 2. Initialization
```bash
workplan init
```
Initialize your local workspace security and storage.

### 3. Authentication
```bash
workplan login
```
Securely link your CLI to your professional cloud profile.

---

## �️ Command Reference

| Domain | Command | Description |
| :--- | :--- | :--- |
| **Strategy** | `workplan sprint` | Generate a 4-week roadmap from core business objectives. |
| **Planning** | `workplan plan` | Expands intent into actionable tasks with automated SP estimation. |
| **Execution** | `workplan task` | Deep-dive into technical requirements and daily microtasks. |
| **Tracking** | `workplan sync` | Intelligent Git-to-Task mapping for automated status updates. |
| **Reporting** | `workplan report` | Instant executive summaries of team velocity and individual contribution. |
| **Social** | `workplan slack` | Managed Slack delivery for daily/weekly transparency. |
| **Enterprise** | `workplan sheets` | Bi-directional synchronization with institutional Google Sheets. |

---

## 🔒 Security & Data Integrity

> [!IMPORTANT]
> **Zero Local Secrets**: We utilize the system keychain (via `keyring`) only for your primary Workplan Cloud API key. All downstream integration secrets (GitHub, Slack, Jira) are managed in specialized, encrypted hardware modules on our backend.

### Ethical AI Principles
- **Grounding**: AI suggestions are strictly grounded in your provided goals and current `git diff` context.
- **Non-Persistence**: We do not use your proprietary codebase context to train global models.
- **Human-in-the-loop**: All AI-authored tasks and reports must be reviewed by the engineer before being committed to record.

---

## 🔗 Enterprise Integrations
Manage your organizational connections via the [Workplan AI Integration Portal](https://visualvortexcreatives.vercel.app/integrations).

- **Slack**: Automated daily standups and end-of-day summaries.
- **GitHub**: Bi-directional issue tracking and commit mapping.
- **Google Sheets**: Institutional reporting and audit-ready execution logs.
- **Jira**: Enterprise project management synchronization (Managed integration).

---

## 🤝 Contributing & Support
We welcome institutional contributions. Please review our [Security Policy](SECURITY.md) before reporting vulnerabilities.

- **Issue Tracker**: Report bugs at [github.com/SahilSelokar/workplan-ai/issues](https://github.com/SahilSelokar/workplan-ai/issues).
- **Branding**: Crafted with precision by **Sahil Selokar** and the Workplan Technical Team.

---

## 📄 License
Licensed under the **MIT License**. See [LICENSE](LICENSE) for details.