scitex-dev 0.4.2

Shared developer utilities for the SciTeX ecosystem

SciTeX Dev (scitex-dev)

Shared developer utilities for the SciTeX ecosystem

Full Documentation · pip install scitex-dev

---

Problem

The SciTeX ecosystem spans multiple packages (scitex-clew, scitex-writer, scitex-stats, figrecipe, etc.), each with their own documentation, versions, APIs, and CLI commands. Keeping them in sync, discovering what's available, and maintaining consistency across the ecosystem becomes increasingly difficult as it grows.

Solution

scitex-dev provides a unified toolkit for developing and maintaining the SciTeX ecosystem:

• Docs aggregation — discover, build, and search documentation across all packages from a single entry point
• Unified search — search Python APIs, CLI commands, MCP tools, and docs with fuzzy matching and Google-like syntax
• Version management — track, compare, and fix version mismatches across pyproject.toml, __init__.py, git tags, PyPI, and RTD
• Bulk rename — safe, preview-able renaming with cross-reference updates across the entire codebase
• LLM-friendly types — Result, ErrorCode, @supports_return_as for consistent structured responses

Zero runtime dependencies. Pure stdlib.

Installation

pip install scitex-dev

# With CLI support:
pip install scitex-dev[cli]

# With MCP server:
pip install scitex-dev[mcp]

# Everything:
pip install scitex-dev[all]

Quick Start

import scitex_dev

# Unified search across the ecosystem
results = scitex_dev.search("save figure")

# Version management
versions = scitex_dev.list_versions()
mismatches = scitex_dev.get_mismatches()

# Documentation aggregation
docs = scitex_dev.get_docs(package="scitex-writer", format="json")

Four Interfaces

Python API

import scitex_dev

# Search
scitex_dev.search("ttest", scope="api")
scitex_dev.search('+required -excluded "exact phrase"')

# Docs
scitex_dev.get_docs()
scitex_dev.get_docs(package="scitex-writer", format="json")
scitex_dev.build_docs(package="scitex-writer")
scitex_dev.search_docs("installation")

# Versions
scitex_dev.list_versions()
scitex_dev.check_versions(["scitex", "figrecipe"])
scitex_dev.get_mismatches()
scitex_dev.fix_mismatches(dry_run=True)

# LLM-friendly types
from scitex_dev import Result, supports_return_as

@supports_return_as
def my_function(x: int) -> int:
    return x * 2

result = my_function(5, return_as="result")
# Result(success=True, data=10)

CLI Commands

# Ecosystem management
scitex-dev ecosystem list
scitex-dev ecosystem list --versions
scitex-dev ecosystem fix-mismatches --dry-run
scitex-dev ecosystem sync

# Documentation
scitex-dev docs --package scitex-writer
scitex-dev search "save figure"

# Bulk rename
scitex-dev rename old_name new_name --dry-run

# See all commands
scitex-dev --help
scitex-dev --help-recursive

MCP Server

# Start server
scitex-dev mcp start

# Check setup
scitex-dev mcp doctor
scitex-dev mcp list-tools

# Installation info
scitex-dev mcp installation

Claude Code Setup — add .mcp.json to your project root. Use SCITEX_DEV_ENV_SRC to load configuration from a .src file:

{
  "mcpServers": {
    "scitex-dev": {
      "command": "scitex-dev",
      "args": ["mcp", "start"],
      "env": {
        "SCITEX_DEV_ENV_SRC": "${SCITEX_DEV_ENV_SRC}"
      }
    }
  }
}

Switch environments via your shell profile:

# Local machine
export SCITEX_DEV_ENV_SRC=~/.scitex/dev/local.src

# Remote server
export SCITEX_DEV_ENV_SRC=~/.scitex/dev/remote.src

Skills — for AI Agent Discovery

Skills provide workflow-oriented guides that AI agents query to discover capabilities and usage patterns.

scitex-dev skills list              # List available skill pages
scitex-dev skills get SKILL         # Show main skill page
scitex-dev skills export --package scitex-dev  # Export to Claude Code

Skill	Content
result-types	Result, ErrorCode, @supports_return_as for LLM-friendly responses
cli-mcp-utils	CLI and MCP utility helpers
versions	Version management, mismatch detection and fixing
ecosystem	Ecosystem list, sync, and commit workflows
rename	Safe bulk rename with cross-reference updates
docs-search	Documentation aggregation and unified search
test-runner	Local and HPC test execution
config	Package configuration and priority config patterns

Part of SciTeX

scitex-dev is part of SciTeX. It provides the shared infrastructure that keeps the ecosystem consistent and discoverable. When used with the orchestrator package scitex, it enables unified version management and documentation across all modules:

import scitex_dev

# See the entire ecosystem at a glance
versions = scitex_dev.list_versions()
mismatches = scitex_dev.get_mismatches()

# Search across all installed SciTeX packages
scitex_dev.search("statistical test")

The SciTeX system follows the Four Freedoms for Research below, inspired by the Free Software Definition:

Four Freedoms for Research

0. The freedom to run your research anywhere — your machine, your terms.
1. The freedom to study how every step works — from raw data to final manuscript.
2. The freedom to redistribute your workflows, not just your papers.
3. The freedom to modify any module and share improvements with the community.

AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

---