light-project-structure

Generate a standardized scientific research project skeleton with templates and DVC integration.

514|67|Updated Jun 7, 2026
One-click install
npx skills add https://github.com/Light0305/Light-skills --skill light-project-structure
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: light-project-structure
Source: https://github.com/Light0305/Light-skills/tree/main/skills/light-project-structure
Command: npx skills add https://github.com/Light0305/Light-skills --skill light-project-structure

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

规范化科研项目结构,快速搭建可扩展的骨架,确保数据、代码、结果与文档等在同一约定下组织,便于复现实验和协作。

Core Features & Use Cases

  • 标准化骨架:data/raw、data/interim、data/processed、data/external、src、models、experiments、results、figures、notebooks/exploratory、notebooks/reports、configs、logs、references、docs、paper、ppt、patent、software-copyright、assets、tests、notebooks、.light 等目录及命名约束。
  • 模板与脚手架:自动生成 README.md、CHANGELOG.md、PROJECT_PLAN.md、PROJECT_STRUCTURE.md、pyproject.toml/.gitignore/.editorconfig/.pre-commit-config.yaml,默认后端为 uv,支持 Poetry。
  • 脚本化创建:包含 scripts/scaffold.py,一次性创建骨架并可选地初始化 DVC、以及放置一个 dataset 桩用于演示。
  • 与 CCDS 等工作流最佳实践的对齐,提供数据/笔记/实验分流与追溯。

Quick Start

Run python scaffold.py <target> --name <name> --module <module> to generate a ready-to-use project skeleton.

Frequently Asked Questions about light-project-structure

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

FAQPage Schema
How do I create a standardized research project structure for reproducibility?

To create a standardized research project structure, you can generate an end-to-end project skeleton that organizes data, code, and results. This ensures reproducibility by provisioning a CCDS-aligned directory layout with ready-made templates.

What is the best way to scaffold a scientific research repository with Python?

The best way to scaffold a scientific research repository is to use a script that automatically creates standardized directories and configuration files. This approach provisions a complete project skeleton, including README, pyproject.toml, and .gitignore, in one command.

Does this project scaffolding tool support DVC integration for data versioning?

Yes, this project scaffolding tool supports DVC integration for data versioning. The scaffold script can optionally initialize DVC and place a dataset stub during the project skeleton creation to help manage data pipelines.

Can I use Poetry instead of uv as the backend for my research project setup?

Yes, you can use Poetry instead of uv as the backend for your research project setup. While the default backend is uv, the generated pyproject.toml and project structure fully support Poetry for dependency management.

How does the CCDS-aligned directory layout organize notebooks and experiments?

The CCDS-aligned directory layout organizes notebooks and experiments by separating them into dedicated folders. Notebooks are split into exploratory and reports, while experiments, models, and results have distinct directories to ensure clear data and code separation.

What templates are included when generating a reproducible research project skeleton?

When generating a reproducible research project skeleton, templates for README.md, CHANGELOG.md, PROJECT_PLAN.md, and pyproject.toml are included. Pre-commit configurations and editorconfig files are also provisioned to enforce coding standards.