Metadata-Version: 2.4
Name: classdock
Version: 0.4.0
Summary: Modern Python CLI for automating GitHub Classroom assignment management
License: MIT
License-File: LICENSE
Keywords: github,classroom,education,automation,cli
Author: Hugo Valle
Author-email: hugovalle1@weber.edu
Requires-Python: >=3.10
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Education
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: System :: Systems Administration
Classifier: Environment :: Console
Provides-Extra: dev
Requires-Dist: PyGithub (>=1.59.0)
Requires-Dist: PyNaCl (>=1.5.0)
Requires-Dist: black (>=23.7.0) ; extra == "dev"
Requires-Dist: click (>=8.0.0,<8.2.0)
Requires-Dist: cryptography (>=41.0.0)
Requires-Dist: flake8 (>=6.0.0) ; extra == "dev"
Requires-Dist: isort (>=5.12.0) ; extra == "dev"
Requires-Dist: mypy (>=1.5.0) ; extra == "dev"
Requires-Dist: pre-commit (>=3.3.0) ; extra == "dev"
Requires-Dist: pytest (>=7.4.0) ; extra == "dev"
Requires-Dist: pytest-cov (>=4.1.0) ; extra == "dev"
Requires-Dist: pytest-mock (>=3.11.0) ; extra == "dev"
Requires-Dist: pyyaml (>=6.0.1)
Requires-Dist: questionary (>=2.0.0)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: rich (>=13.0.0)
Requires-Dist: typer (>=0.12.0)
Requires-Dist: types-PyYAML (>=6.0.12) ; extra == "dev"
Requires-Dist: types-requests (>=2.31.0) ; extra == "dev"
Project-URL: Bug Reports, https://github.com/hugo-valle/classdock/issues
Project-URL: Documentation, https://github.com/hugo-valle/classdock#readme
Project-URL: Feature Requests, https://github.com/hugo-valle/classdock/issues
Project-URL: Homepage, https://github.com/hugo-valle/classdock
Project-URL: Repository, https://github.com/hugo-valle/classdock
Description-Content-Type: text/markdown

# ClassDock

> Automate GitHub Classroom assignment management with a modern Python CLI

[![PyPI version](https://badge.fury.io/py/classdock.svg)](https://badge.fury.io/py/classdock)
[![Python Support](https://img.shields.io/pypi/pyversions/classdock.svg)](https://pypi.org/project/classdock/)
[![CI](https://github.com/hugo-valle/classdock/actions/workflows/ci.yml/badge.svg)](https://github.com/hugo-valle/classdock/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

ClassDock is a command-line tool for computer science instructors who manage [GitHub Classroom](https://classroom.github.com/) assignments. Instead of manually clicking through dozens of student repositories, ClassDock automates the repetitive work — discovering repos, distributing secrets, tracking roster acceptance — so you can focus on teaching.

**Perfect for:** Instructors managing GitHub Classroom assignments for classes of any size.

---

## Installation

```bash
pip install classdock
```

**Requirements:** Python 3.10+ and Git

---

## Quick Start

```bash
# 1. Set up your GitHub token (one-time)
classdock token

# 2. Create a new assignment
classdock setup

# 3. Discover all student repositories
classdock fetch

# 4. Add secrets to every student repo at once
classdock secrets add

# 5. Run the full workflow end-to-end
classdock run
```

---

## Shortcut Commands

These shortcuts cover the most common operations without navigating command groups:

| Command | What it does |
|---------|--------------|
| `classdock run` | Run the full assignment workflow (`assignments orchestrate`) |
| `classdock setup` | Launch the interactive assignment setup wizard |
| `classdock fetch` | Discover all student repositories from GitHub Classroom |
| `classdock status` | Show assignment dashboard (repos, roster, token status) |
| `classdock token` | Configure your GitHub Personal Access Token |

---

## Command Groups

For full control, every feature is available through organized command groups:

| Group | Description |
|-------|-------------|
| `classdock assignments` | Assignment lifecycle: setup wizard, orchestration, student helpers |
| `classdock repos` | Repository discovery |
| `classdock secrets` | Distribute secrets and tokens to all student repos |
| `classdock roster` | Student roster management with CSV import and assignment tracking |
| `classdock automation` | Cron scheduling for automated workflow steps |
| `classdock config` | GitHub token configuration and validation |

See the **[Full Command Reference](docs/COMMANDS.md)** for every subcommand and option.

---

## Configuration

ClassDock reads an `assignment.conf` file from your assignment directory:

```bash
# Minimal configuration
classroom_url="https://classroom.github.com/classrooms/123/assignments/456"
github_organization="your-github-org"
assignment_name="homework-1"

# Optional: secrets to distribute to every student repo
secrets_list="API_KEY,DATABASE_URL"

# Optional: enable roster sync during orchestration
step_sync_roster=true
```

Run `classdock setup` to generate this file interactively.

---

## Roster Management

Track which students accepted an assignment and link their GitHub repos to your class roster:

```bash
# Initialize (one-time, stores data in ~/.config/classdock/roster.db)
classdock roster init

# Import your student list from a Google Forms CSV export
classdock roster import students.csv --org=cs101-fall2025

# After fetching repos, link them to roster entries
classdock roster sync --assignment=homework-1 --org=cs101-fall2025

# See who has and hasn't accepted
classdock roster status --org=cs101-fall2025
```

See **[Roster Sync Guide](docs/ROSTER_SYNC.md)** for detailed setup.

---

## Documentation

| Document | Description |
|----------|-------------|
| [Full Command Reference](docs/COMMANDS.md) | Every command, subcommand, and option |
| [Roster Sync Guide](docs/ROSTER_SYNC.md) | Roster management and orchestrator integration |
| [Error Handling](docs/ERROR_HANDLING.md) | GitHub API resilience and retry patterns |
| [CI/CD Workflow](docs/CICD_WORKFLOW.md) | Automated testing and PyPI publishing |
| [Contributing Guide](docs/CONTRIBUTING.md) | Development workflow and guidelines |
| [Changelog](docs/CHANGELOG.md) | Release history |

---

## Contributing

Contributions are welcome. Please read the [Contributing Guide](docs/CONTRIBUTING.md) before opening a pull request.

---

## License

MIT License — see [LICENSE](LICENSE) for details.

---

Made with care for computer science educators.

