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 Coverage License: AGPL-3.0

Full Documentation · pip install scitex-dev


Problem and Solution

# Problem Solution
1 ~70 ecosystem packages drift apart -- versions, READMEs, sphinx setups, CLI conventions diverge faster than humans can audit scitex-dev ecosystem audit-* -- audit-project, audit-cli, audit-mcp-tools, audit-python-apis, audit-skills, audit-summary enforce ~130 numbered rules across the whole ecosystem
2 Skills scattered across ~70 source repos -- AI agents can't discover them; humans can't review them scitex-dev skills list / get / export -- aggregate every package's _skills/ and symlink them into ~/.claude/skills/scitex/ for live-edit dev loops
3 Coordinated releases need ten manual steps -- bump version, push tag, watch CI, verify PyPI, deploy — done per-package, multiplied by 70 scitex-dev ecosystem sync + check-versions + start-dashboard -- one-shot install/sync across hosts, version-mismatch detection, and a web dashboard with the live state
4 Bulk renames across 70 repos break cross-references -- import paths, doc references, symlinks — sed -i corrupts something every time scitex-dev rename-symbols -- atomic rename with cross-reference updates, regex support, dry-run preview, git-safety guards

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]

Configuration

Copy .env.example to .env (gitignored) at your project root, then edit. CLI flags always override env vars. The full list (with inline comments) lives in .env.example.

Local state directories

scitex-dev reads optional config + cache from the canonical SciTeX local-state locations:

Path Scope Purpose
~/.scitex/dev/ user-global per-user config, cache
<proj-root>/.scitex/dev/ project-local overrides for the current repo

Project-local wins when both exist. Both are optional.

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 ⭐⭐⭐ (primary)
# 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-docs "save figure"

# Bulk rename
scitex-dev rename-symbols 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 ⭐⭐⭐ (primary)

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

Full skills directory

Skill Content
result-types Result, ErrorCode, @supports_return_as for LLM-friendly responses
cli-mcp-utils CLI and MCP utility helpers
config Package configuration and priority config patterns
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
full-update / full-update-deploy End-to-end audit → bump → release → sync pipelines
agentic-test-overview / -skills / -mcp Agent-vs-agent quality testing
dynamic-audit Cross-package periodic audit checklist
env-vars SCITEX_DEV_* / SCITEX_* environment variable reference

Part of SciTeX

scitex-dev is part of SciTeX. Install via the umbrella with pip install scitex[dev] to use as scitex.dev (Python) or scitex dev ... (CLI).

SciTeX 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.11.3.tar.gz (10.7 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.11.3-py3-none-any.whl (9.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scitex_dev-0.11.3.tar.gz
  • Upload date:
  • Size: 10.7 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.11.3.tar.gz
Algorithm Hash digest
SHA256 578b3070c338374c88e0251b9810670ddb5045a091c95a8b4c34ba2c5c65ae12
MD5 eefe2fe90760ddf6eb663b0e208c9287
BLAKE2b-256 7d1b3d0c934711e87d868e7c85c5810396fb5bd246b75da96ad65eba72290c8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_dev-0.11.3.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.11.3-py3-none-any.whl.

File metadata

  • Download URL: scitex_dev-0.11.3-py3-none-any.whl
  • Upload date:
  • Size: 9.9 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.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 312e2f728b96454d304cbfef9becbdcaebff49a4904464cb566dca1286120a4a
MD5 893f75d795bd8bd2e55428e3228efc06
BLAKE2b-256 e6f6bc682c1f45fc21726c28aac247d350a5f027987d634bdc158e8b4551412c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_dev-0.11.3-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