skills.rest
codefun-tech
codefun-techCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

check-repository

Summarize git state, project structure, and configuration for Python repositories.

Updated Jun 5, 2024
Search Tags:#pytest#repository#mypy#code-quality#lint#health-check#git-status
One-click install
npx skills add https://github.com/codefun-tech/python_starter --skill check-repository
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-repository
Source: https://github.com/codefun-tech/python_starter/tree/main/.opencode/skills/check-repository
Command: npx skills add https://github.com/codefun-tech/python_starter --skill check-repository

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Checks repository health by summarizing git state, project structure, and configuration.

Core Features & Use Cases

  • Checks presence and state of common repo elements (src/, tests/, pyproject.toml, config files)
  • Reports on git status, uncommitted changes, and code-quality results (flake8, mypy, pytest)
  • Use case: run this to get a concise health snapshot of a project before starting a review or onboarding

Quick Start

Run the repository health check from the project root using the provided script.

Frequently Asked Questions about check-repository

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check the health of a Python repository before a code review?▼

To check Python repository health, run a script from the project root that summarizes git status, project structure, and configuration. This surfaces uncommitted changes and missing elements like src/, tests/, or pyproject.toml before development.

What does a Python repository health check include?▼

A repository health check includes verifying the presence of src/, tests/, and pyproject.toml, reporting on git status, and summarizing code-quality metrics from flake8, mypy, and pytest configurations.

Can I use this health check for Python projects of varying sizes?▼

Yes, this health check applies to Python projects of varying sizes. It quickly surfaces structural and configuration issues, making it suitable for onboarding to large repositories or validating small project setups.

How do I detect git status and uncommitted changes in my Python project?▼

You detect git status and uncommitted changes by running the repository health check script from your project root. It summarizes the current git state alongside project structure and configuration validity.

What's the best way to surface pytest and mypy issues in a repository?▼

The best way to surface pytest and mypy issues is running a repository health check that reports code-quality results. It aggregates these metrics with git status and directory structure for a concise project snapshot.

Does this repository health check validate pyproject.toml configuration?▼

Yes, the repository health check validates pyproject.toml configuration. It checks the presence and state of common repo elements, including config files, to ensure your Python project is correctly configured.

Related Skills

Explore More Software Engineering Skills→
Renzo-TognellaRenzo-Tognella

Python Project Setup & Structure

Set up a Python 3.11+ project with pyproject.toml and uv.

Community
Advanced
c-dalyc-daly

verify

Run ruff, black, mypy, and pytest checks on Python code.

Community
Intermediate
eyadsibaieyadsibai
7

Code Quality

Analyzes code quality including style, complexity, dead code, and type hints.

Community
Advanced
birgitta410birgitta410
15

sensors_config-default

Generate project-specific sensor definitions and directory structures for sensors-cli.

Community
Basic