Skip to main content

SciTeX Cloud - Deployment and management CLI for SciTeX

Project description

SciTeX Cloud

PyPI version Python Versions License

scitex.ai · pip install scitex-cloud


Open-source scientific research platform — web interface for the scitex ecosystem.

Provides Scholar, Writer, Vis, Console, and Hub modules as a Django web application with Docker deployment, plus a pip-installable CLI and MCP server for AI integration.

Status: Alpha (data may be lost)

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 research infrastructure deserves the same freedoms as the software it runs on.

Installation

pip install scitex-cloud              # CLI only
pip install scitex-cloud[mcp]         # CLI + MCP server
pip install scitex-cloud[all]         # Everything

Three Interfaces

Python API
import scitex_cloud

# Version and health
scitex_cloud.__version__        # "0.8.0-alpha"
scitex_cloud.get_version()      # Version string
scitex_cloud.health_check()     # Service health status
CLI Commands
scitex-cloud --help                    # Help
scitex-cloud --help-recursive          # All commands recursively
scitex-cloud --version                 # Version

# Git hosting (Gitea)
scitex-cloud gitea list                # List repositories
scitex-cloud gitea clone user/repo     # Clone repository
scitex-cloud gitea push                # Push changes
scitex-cloud gitea pr create           # Create pull request
scitex-cloud gitea issue create        # Create issue

# Docker management
scitex-cloud docker status             # Container status
scitex-cloud docker logs               # View logs

# MCP server
scitex-cloud mcp start                 # Start MCP server
scitex-cloud mcp list-tools            # List available tools
scitex-cloud mcp doctor                # Diagnose setup
scitex-cloud mcp installation          # Client config instructions

# Utilities
scitex-cloud status                    # Deployment status
scitex-cloud completion                # Shell completion setup
scitex-cloud list-python-apis          # List all Python APIs
MCP Tools — 23 tools for AI Agents
Category Tools Description
cloud 14 Git operations (clone, push, pull, PR, issues)
api 9 Scholar search, CrossRef, BibTeX enrichment

Claude Desktop (~/.config/claude/claude_desktop_config.json):

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

Web Platform

Quick Start (Docker)
git clone https://github.com/ywatanabe1989/scitex-cloud.git
cd scitex-cloud
make start                    # Development environment

# Access at: http://localhost:8000
# Gitea: http://localhost:3000
# Test user: test-user / Password123!
Deployment
make start                    # Development (default)
make ENV=prod start           # Production
make ENV=prod status          # Health check
make ENV=prod db-backup       # Backup database
make help                     # All available commands
Configuration

.env files in deployment/docker/envs/ (gitignored):

.env.dev        # Development
.env.prod       # Production
.env.staging    # Staging
.env.example    # Template (tracked)

Key variables:

SCITEX_CLOUD_DJANGO_SECRET_KEY=your-secret-key
SCITEX_CLOUD_POSTGRES_PASSWORD=strong-password
SCITEX_CLOUD_GITEA_TOKEN=your-token
Project Structure
scitex-cloud/
├── apps/                    # Django applications
│   ├── scholar_app/        # Literature discovery
│   ├── writer_app/         # Scientific writing
│   ├── console_app/        # Terminal & code execution
│   ├── vis_app/            # Data visualization
│   ├── hub_app/            # Project hub & file browser
│   ├── project_app/        # Project management
│   ├── clew_app/           # Verification pipeline
│   └── public_app/         # Landing page & tools
│
├── deployment/docker/
│   ├── docker_dev/         # Development compose
│   ├── docker_prod/        # Production compose
│   └── envs/               # .env files (gitignored)
│
├── config/                  # Django settings
├── static/                  # Shared frontend assets
├── src/scitex_cloud/        # pip package (CLI + MCP)
├── tests/                   # Test suite
└── Makefile                 # Thin dispatcher

Contributing

We welcome contributions! See CONTRIBUTING.md.


SciTeX
AGPL-3.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

scitex_cloud-0.11.0a0.tar.gz (59.6 kB view details)

Uploaded Source

Built Distribution

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

scitex_cloud-0.11.0a0-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

Details for the file scitex_cloud-0.11.0a0.tar.gz.

File metadata

  • Download URL: scitex_cloud-0.11.0a0.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_cloud-0.11.0a0.tar.gz
Algorithm Hash digest
SHA256 b569b321f963404ffd673a41b336cd34d48564f5a0e3d8e8145eb565b2b104fd
MD5 b0f2a1ca46cff817c2785885244585be
BLAKE2b-256 4d35963b1cdf62d11ba52c0cfef38757e48ae6626cb24a35d899fd8bc3182045

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_cloud-0.11.0a0.tar.gz:

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

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_cloud-0.11.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for scitex_cloud-0.11.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 109e84b455d62321b43bb95402b4c623d8ce53bab12c54d16277ea4c799cd198
MD5 d63ff7ae7adfd5f92be4c4df48b33620
BLAKE2b-256 20862c18bb1ce5370ed298a970a8aa6f80c3ebc5795c05ec949a84ca5d0565ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_cloud-0.11.0a0-py3-none-any.whl:

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

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