# 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
```bash
# ๅบ็กๅฎ่ฃ
(ไป
utils ๆ ธๅฟๅ่ฝ)
pip install isage-common
# ๅบ็ก + CLI ๅทฅๅ
ท
pip install isage-common[cli]
# ๆ่
pip install isage-common[basic]
# CLI + ๅผๅๅทฅๅ
ท
pip install isage-common[tools]
# ๅผๅ็ฏๅขๅฎๆดๅฎ่ฃ
pip install isage-common[dev]
# Frontend/Web ๅ่ฝ
pip install isage-common[frontend]
# ๆ่
pip install isage-common[web]
# ๆๆกฃ็ๆๅทฅๅ
ท
pip install isage-common[docs]
# ๅฎๆดๅฎ่ฃ
(ๆๆๅ่ฝ)
pip install isage-common[full]
```
## Quick Start
### Using Utilities
```python
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
```bash
# 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
```bash
# 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
```bash
# Start SAGE web server
sage-frontend
# Start dashboard
sage-dashboard
# Start server with custom config
sage-server --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
โโโ sage_server/ # FastAPI server implementation
โโโ static/ # Static web assets
โโโ templates/ # HTML templates
```
## Contributing
This package is part of the SAGE monorepo. Please see the main [SAGE repository](https://github.com/intellistream/SAGE) for contribution guidelines.
## License
MIT License - see the [LICENSE](../../LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "isage-common",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "sage, utils, cli, development, tools, configuration, logging, testing, intellistream",
"author": null,
"author_email": "IntelliStream Team <intellistream@outlook.com>",
"download_url": null,
"platform": null,
"description": "# SAGE Common - Utilities, CLI, Development Tools & Frontend\n\nThis package provides the core utilities, command-line interface, development tools, and web frontend for the SAGE (Stream Analytics in Go-like Environments) framework.\n\n## Features\n\n### \ud83d\udee0\ufe0f Core Utilities (`sage.utils`)\n- Configuration management with YAML/TOML support\n- Flexible logging system with multiple backends\n- Platform-specific directory management\n- Type validation with Pydantic models\n- Common data structures and helpers\n\n### \ud83d\udcbb Command Line Interface (`sage.cli`)\n- Rich CLI with auto-completion support\n- Interactive questionnaires and prompts\n- Beautiful table formatting and progress bars\n- Cross-platform shell integration\n- Core SAGE system management commands\n\n### \ud83d\udd27 Development Toolkit (`sage.dev`)\n- Automated testing with pytest integration\n- Code quality tools (black, isort, mypy, ruff)\n- Package management and publishing\n- Performance profiling and benchmarking\n- Documentation generation tools\n\n### \ud83c\udf10 Web Frontend (`sage.frontend`)\n- FastAPI-based web server and dashboard\n- Real-time websocket communication\n- Interactive data visualization\n- Authentication and security features\n- RESTful API endpoints\n\n## Installation\n\n```bash\n# \u57fa\u7840\u5b89\u88c5 (\u4ec5 utils \u6838\u5fc3\u529f\u80fd)\npip install isage-common\n\n# \u57fa\u7840 + CLI \u5de5\u5177\npip install isage-common[cli]\n# \u6216\u8005\npip install isage-common[basic]\n\n# CLI + \u5f00\u53d1\u5de5\u5177\npip install isage-common[tools]\n\n# \u5f00\u53d1\u73af\u5883\u5b8c\u6574\u5b89\u88c5\npip install isage-common[dev]\n\n# Frontend/Web \u529f\u80fd\npip install isage-common[frontend]\n# \u6216\u8005\npip install isage-common[web]\n\n# \u6587\u6863\u751f\u6210\u5de5\u5177\npip install isage-common[docs]\n\n# \u5b8c\u6574\u5b89\u88c5 (\u6240\u6709\u529f\u80fd)\npip install isage-common[full]\n```\n\n## Quick Start\n\n### Using Utilities\n\n```python\nfrom sage.utils.config import load_config\nfrom sage.utils.logging import get_logger\n\n# Load configuration\nconfig = load_config(\"my_config.yaml\")\n\n# Set up logging\nlogger = get_logger(\"my_app\")\nlogger.info(\"Hello SAGE!\")\n```\n\n### Using CLI\n\n```bash\n# Basic SAGE commands\nsage --help\nsage config show\nsage status\n\n# Core system management\nsage-core start\nsage-core status\nsage-core stop\n```\n\n### Using Development Tools\n\n```bash\n# Run tests\nsage-dev test\n\n# Code analysis\nsage-dev analyze\n\n# Package management\nsage-dev package build\nsage-dev package publish\n\n# Generate reports\nsage-dev report coverage\nsage-dev report performance\n```\n\n### Using Frontend\n\n```bash\n# Start SAGE web server\nsage-frontend\n\n# Start dashboard \nsage-dashboard\n\n# Start server with custom config\nsage-server --config my_config.yaml\n```\n\n## Package Structure\n\n```\nsrc/sage/\n\u251c\u2500\u2500 utils/ # Core utilities\n\u2502 \u251c\u2500\u2500 config/ # Configuration management\n\u2502 \u251c\u2500\u2500 logging/ # Logging system\n\u2502 \u251c\u2500\u2500 types/ # Type definitions\n\u2502 \u2514\u2500\u2500 helpers/ # Helper functions\n\u251c\u2500\u2500 cli/ # Command line interface\n\u2502 \u251c\u2500\u2500 commands/ # CLI command implementations\n\u2502 \u251c\u2500\u2500 prompts/ # Interactive prompts\n\u2502 \u2514\u2500\u2500 formatters/ # Output formatting\n\u251c\u2500\u2500 dev/ # Development tools\n\u2502 \u251c\u2500\u2500 testing/ # Test automation\n\u2502 \u251c\u2500\u2500 quality/ # Code quality tools\n\u2502 \u251c\u2500\u2500 packaging/ # Package management\n\u2502 \u2514\u2500\u2500 docs/ # Documentation tools\n\u2514\u2500\u2500 frontend/ # Web frontend and dashboard\n \u251c\u2500\u2500 sage_server/ # FastAPI server implementation\n \u251c\u2500\u2500 static/ # Static web assets\n \u2514\u2500\u2500 templates/ # HTML templates\n```\n\n## Contributing\n\nThis package is part of the SAGE monorepo. Please see the main [SAGE repository](https://github.com/intellistream/SAGE) for contribution guidelines.\n\n## License\n\nMIT License - see the [LICENSE](../../LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "SAGE Common Libraries (Unified Package)",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/intellistream/SAGE/issues",
"Documentation": "https://intellistream.github.io/SAGE-Pub/",
"Homepage": "https://github.com/intellistream/SAGE",
"Repository": "https://github.com/intellistream/SAGE.git"
},
"split_keywords": [
"sage",
" utils",
" cli",
" development",
" tools",
" configuration",
" logging",
" testing",
" intellistream"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "288d92151e85957033fba09827fe848d113f82e340381a05ad64e3490a27fa0e",
"md5": "d0682debea232d6908d807b17ea985ae",
"sha256": "f057ce8cb349269358ac163e5eb2b559f986515a1d731c561eeafbed4cf91aa8"
},
"downloads": -1,
"filename": "isage_common-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0682debea232d6908d807b17ea985ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 219115,
"upload_time": "2025-08-11T13:29:31",
"upload_time_iso_8601": "2025-08-11T13:29:31.916629Z",
"url": "https://files.pythonhosted.org/packages/28/8d/92151e85957033fba09827fe848d113f82e340381a05ad64e3490a27fa0e/isage_common-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 13:29:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "intellistream",
"github_project": "SAGE",
"github_not_found": true,
"lcname": "isage-common"
}
JSON
