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

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 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]

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")

Three 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
# Version management
scitex-dev versions
scitex-dev fix-mismatches --dry-run

# 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

Add to your MCP client configuration:

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

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 ecosystem follows the Four Freedoms for researchers:

  • Freedom 0 — Run the software for any research purpose
  • Freedom 1 — Study and modify the source code
  • Freedom 2 — Share copies with colleagues
  • Freedom 3 — Share your modifications with the community

License

AGPL-3.0-only. See LICENSE.


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.2.0.tar.gz (1.1 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.2.0-py3-none-any.whl (117.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scitex_dev-0.2.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for scitex_dev-0.2.0.tar.gz
Algorithm Hash digest
SHA256 76fb7ecb8a9c52340e0f608eca54d0d7ea87c8bae4989ef99da46ec2420e6f80
MD5 904c25cf5b887d7f5c9bb5457793697f
BLAKE2b-256 8eefe459b948add0bcaa08a3479ce2913ee73156faf24ea2a090dc96678c613c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scitex_dev-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 117.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for scitex_dev-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 da27b0de9ad08ef2167fe85a6d6037d24004628d17171fb69343518b44cfee6e
MD5 fe558a2726601c452439d8cac67c816a
BLAKE2b-256 204eac4880a30f8ca86992ede6140e6736c87c4a3c978ef51ede9c46b2b9b2fc

See more details on using hashes here.

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