Skip to main content

SAGE Development Tools - CLI, Web UI, and Development Utilities

Project description

SAGE Common - Utilities, CLI, Development Tools & Frontend

This package provides the core utilities, command-line interface, development tools, and web frontend for the SAGE (Stream Analytics in Go-like Environments) framework.

Features

🛠️ Core Utilities (sage.utils)

  • Configuration management with YAML/TOML support
  • Flexible logging system with multiple backends
  • Platform-specific directory management
  • Type validation with Pydantic models
  • Common data structures and helpers

💻 Command Line Interface (sage.cli)

  • Rich CLI with auto-completion support
  • Interactive questionnaires and prompts
  • Beautiful table formatting and progress bars
  • Cross-platform shell integration
  • Core SAGE system management commands

🔧 Development Toolkit (sage.dev)

  • Automated testing with pytest integration
  • Code quality tools (black, isort, mypy, ruff)
  • Package management and publishing
  • Performance profiling and benchmarking
  • Documentation generation tools

🌐 Web Frontend (sage.frontend)

  • FastAPI-based web server and dashboard
  • Real-time websocket communication
  • Interactive data visualization
  • Authentication and security features
  • RESTful API endpoints

Installation

# 基础安装 (仅 utils 核心功能)
pip install isage-common

# 基础 + CLI 工具
pip install isage-tools
# 或者
pip install isage-common[basic]

# CLI + 开发工具
pip install isage-common[tools]

# 开发环境完整安装
pip install isage-tools

# Frontend/Web 功能
pip install isage-tools
# 或者
pip install isage-common[web]

# 文档生成工具
pip install isage-common[docs]

# 完整安装 (所有功能)
pip install isage-common[full]

Quick Start

Using Utilities

from sage.utils.config import load_config
from sage.utils.logging import get_logger

# Load configuration
config = load_config("my_config.yaml")

# Set up logging
logger = get_logger("my_app")
logger.info("Hello SAGE!")

Using CLI

# Basic SAGE commands
sage --help
sage config show
sage status

# Core system management
sage-core start
sage-core status
sage-core stop

Using Development Tools

# Run tests
sage-dev test

# Code analysis
sage-dev analyze

# Package management
sage-dev package build
sage-dev package publish

# Generate reports
sage-dev report coverage
sage-dev report performance

Using Frontend

# Start SAGE web server
sage-frontend

# Start dashboard  
sage-dashboard

# Start Studio with custom config
sage studio start --config my_config.yaml

Package Structure

src/sage/
├── utils/           # Core utilities
│   ├── config/      # Configuration management
│   ├── logging/     # Logging system
│   ├── types/       # Type definitions
│   └── helpers/     # Helper functions
├── cli/             # Command line interface
│   ├── commands/    # CLI command implementations
│   ├── prompts/     # Interactive prompts
│   └── formatters/  # Output formatting
├── dev/             # Development tools
│   ├── testing/     # Test automation
│   ├── quality/     # Code quality tools
│   ├── packaging/   # Package management
│   └── docs/        # Documentation tools
└── frontend/        # Web frontend and dashboard
    ├── studio/      # Angular Studio implementation
    ├── static/      # Static web assets
    └── templates/   # HTML templates

Contributing

This package is part of the SAGE monorepo. Please see the main SAGE repository for contribution guidelines.

License

MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

isage_tools-0.1.5.1-py3-none-any.whl (307.3 kB view details)

Uploaded Python 3

File details

Details for the file isage_tools-0.1.5.1-py3-none-any.whl.

File metadata

  • Download URL: isage_tools-0.1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 307.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for isage_tools-0.1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6f2f481adb0ea1a7cb213d05eefe888ce41fbd6ea942b19643636c4d0cb6ac11
MD5 1b0a5bfb54bb76240efa454bdf00a1bc
BLAKE2b-256 b4cc04552c1471b3ed6a82193d019be01248cd4a8e677a6198c54ea092a0cb00

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