Jupyter Notebook Best Practices

'use strict';
/**
 * Post-execute hook for jupyter-notebook-best-practices
 * Auto-generated by enterprise-bundle-scaffolder
 *
 * Records metrics after skill execution.
 */

function postExecute(_context) {
  // Record execution metrics
  return { ok: true, skill: 'jupyter-notebook-best-practices' };
}

module.exports = { postExecute };

'use strict';
/**
 * Pre-execute hook for jupyter-notebook-best-practices
 * Auto-generated by enterprise-bundle-scaffolder
 *
 * Validates inputs before skill execution.
 */

function preExecute(context) {
  // Validate skill invocation context
  if (!context || typeof context !== 'object') {
    return { allow: true, message: 'jupyter-notebook-best-practices: no context to validate' };
  }
  return { allow: true };
}

module.exports = { preExecute };

---
description: Guidelines for structuring and documenting Jupyter notebooks for reproducibility and clarity.
globs: **/*.ipynb
---
- Structure notebooks with clear sections using markdown cells.
- Use meaningful cell execution order to ensure reproducibility.
- Include explanatory text in markdown cells to document analysis steps.
- Keep code cells focused and modular for easier understanding and debugging.
- Use magic commands like %matplotlib inline for inline plotting.
- Document data sources, assumptions, and methodologies clearly.
- Use version control (e.g., git) for tracking changes in notebooks and scripts.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "jupyter-notebook-best-practicesInput",
  "description": "Input schema for Guidelines for structuring and documenting Jupyter notebooks for reproducibility and clarity.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "target": {
      "type": "string",
      "description": "Target file or path for the skill to operate on"
    },
    "options": {
      "type": "object",
      "description": "Additional options for skill execution",
      "additionalProperties": true
    }
  }
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "jupyter-notebook-best-practicesOutput",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "summary": {
      "type": "string"
    }
  }
}

#!/usr/bin/env node
/**
 * jupyter-notebook-best-practices - Rule-based Skill
 * Converted from: jupyter-notebook-best-practices.mdc
 */

const fs = require('fs');
const path = require('path');

// Parse arguments
const args = process.argv.slice(2);
const options = {};
for (let i = 0; i < args.length; i++) {
  if (args[i].startsWith('--')) {
    const key = args[i].slice(2);
    const value = args[i + 1] && !args[i + 1].startsWith('--') ? args[++i] : true;
    options[key] = value;
  }
}

if (options.help) {
  console.log(`
jupyter-notebook-best-practices - Code Guidelines Skill

Usage:
  node main.cjs --check <file>    Check a file against guidelines
  node main.cjs --list            List all guidelines
  node main.cjs --help            Show this help

Description:
  Guidelines for structuring and documenting Jupyter notebooks for reproducibility and clarity.
`);
  process.exit(0);
}

if (options.list) {
  console.log('Guidelines for jupyter-notebook-best-practices:');
  console.log('See SKILL.md for full guidelines');
  process.exit(0);
}

console.log('jupyter-notebook-best-practices skill loaded. Use with Claude for code review.');