Skip to main content

Shared developer utilities for the SciTeX ecosystem

Project description

SciTeX Dev (scitex-dev)

SciTeX

Shared developer utilities for the SciTeX ecosystem

PyPI version Documentation Tests License: AGPL-3.0

Full Documentation · pip install scitex-dev


Problem and Solution

# Problem Solution
1 33 packages get out of sync -- one package bumps a dep; consumers forget to update minima; users hit runtime errors scitex-dev ecosystem suite -- list, diff, sync, fix-mismatches, commit, pull, push — fanout tooling for coordinated releases
2 Skills scattered across 33 source repos -- users can't discover them easily scitex-dev skills export --link -- symlink the full skill pack into ~/.claude/skills/scitex/ for live-edit dev loops
3 Testing against a SLURM cluster requires ssh + sbatch dance -- interrupts local flow scitex-dev test hpc + --poll + --result -- non-blocking submit, query later

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 (v0.5.1) provides a unified toolkit for developing and maintaining the SciTeX ecosystem:

  • Version management — detect and fix version mismatches across pyproject.toml, __init__.py, git tags, and PyPI
  • CI/CD — check GitHub Actions status, wait for workflows, verify PyPI publish
  • Deployment — deploy and verify production on remote hosts
  • Skills — aggregate, export, and verify AI agent skill pages across the ecosystem
  • Docs aggregation — discover, build, and search documentation across all packages
  • LLM-friendly typesResult, 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]

Modules

Module Functions Purpose
skills list_skills, get_skill, export_skills, verify_docs_and_skills AI agent skill discovery and export
fix detect_mismatches, fix_local, fix_remote, fix_init_version, bump_version, determine_bump_type, verify_versions Version mismatch detection and repair
ci check_ci, get_failing_packages, verify_pypi_config, create_github_release, wait_for_workflow, check_pypi_publish GitHub Actions and PyPI integration
deploy deploy_scitex_cloud, verify_production Remote host deployment
versions get_commits_since_tag Commit tracking since last release
_dist_info clean_stale_dist_info Internal: stale dist-info cleanup

Quick Start

from scitex_dev.fix import detect_mismatches, fix_local, verify_versions
from scitex_dev.ci import check_ci, get_failing_packages
from scitex_dev.skills import list_skills, export_skills

# Detect version mismatches across the ecosystem
mismatches = detect_mismatches()

# Fix mismatches locally (dry run by default)
fix_local(packages=["scitex-stats"], confirm=True)

# Check CI status
status = check_ci(packages=["scitex", "figrecipe"])
failing = get_failing_packages()

# List and export AI agent skills
skills = list_skills()
export_skills()

Four Interfaces

Python API
# Version management
from scitex_dev.fix import detect_mismatches, fix_local, fix_remote, verify_versions
mismatches = detect_mismatches()
fix_local(packages=["scitex-stats"], confirm=True)
verify_versions()

# CI/CD
from scitex_dev.ci import check_ci, get_failing_packages, check_pypi_publish
status = check_ci()
failing = get_failing_packages()

# Skills
from scitex_dev.skills import list_skills, get_skill, export_skills
skills = list_skills()
page = get_skill(package="scitex-stats")
export_skills()

# Deployment
from scitex_dev.deploy import deploy_scitex_cloud, verify_production
deploy_scitex_cloud(host="nas", confirm=True)

# Commit tracking
from scitex_dev.versions import get_commits_since_tag
commits = get_commits_since_tag("scitex-stats")

# LLM-friendly types
from scitex_dev import Result, supports_return_as
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
# Private skills (~/.scitex/*/skills/*-private/) are symlinked automatically
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, CI monitoring, and deployment across all modules:

from scitex_dev.fix import detect_mismatches, verify_versions
from scitex_dev.ci import check_ci, get_failing_packages

# See the entire ecosystem at a glance
mismatches = detect_mismatches()
verify_versions()

# Monitor CI across all packages
failing = get_failing_packages()

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

Four Freedoms for Research

  1. The freedom to run your research anywhere — your machine, your terms.
  2. The freedom to study how every step works — from raw data to final manuscript.
  3. The freedom to redistribute your workflows, not just your papers.
  4. 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.


SciTeX

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scitex_dev-0.10.2.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scitex_dev-0.10.2-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file scitex_dev-0.10.2.tar.gz.

File metadata

  • Download URL: scitex_dev-0.10.2.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_dev-0.10.2.tar.gz
Algorithm Hash digest
SHA256 e496038b8485ace20c1d4190fcdb7a5b0968effcbac9f777627f32e3c86a02ae
MD5 469263a7a0ff6949aa654c5ef98683d2
BLAKE2b-256 5d55424a7801092c09aaba5b1185ac5c9138f4b2240ea7fa9a6e89c09c5d4ef6

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_dev-0.10.2.tar.gz:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scitex_dev-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: scitex_dev-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_dev-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8c2f9e26cd88d7cb694d2717173dfc482c350c43683dcb3ae58ac694d621da03
MD5 50854d43587f78686d51446c47337b4e
BLAKE2b-256 147cc48ec6880f7dc5a60d60dd6ee8b6297e4faac7927564ea9c9c8fb7265f73

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_dev-0.10.2-py3-none-any.whl:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page