Skip to main content

The Ultimate Backup, Monitoring, and Security System - Unified CLI for sh_grim, scythe, py_grim, and go_grim

Project description

Grim Reaper - The Ultimate Backup, Monitoring, and Security System

PyPI version License: MIT

A comprehensive system management platform that combines Python, Go, and Bash components for enterprise-grade backup, monitoring, and security operations.

๐Ÿš€ Quick Start

Option 1: Automated Installation (Recommended)

# Download and run the installation script
curl -sSL https://raw.githubusercontent.com/cyber-boost/grim/main/install_dependencies.sh | bash

Option 2: Manual Installation

1. Install Python Package

pip install grim-reaper==1.0.4

2. Install System Dependencies

Ubuntu/Debian:

sudo apt update
sudo apt install -y rsync tar gzip bzip2 xz-utils openssl curl wget ssh-client scp findutils build-essential git

CentOS/RHEL:

sudo yum update -y
sudo yum install -y rsync tar gzip bzip2 xz openssl curl wget openssh-clients findutils gcc gcc-c++ make git

3. Install Go Runtime

# Download and install Go
curl -LO https://go.dev/dl/go1.21.0.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.21.0.linux-amd64.tar.gz
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc
source ~/.bashrc

4. Setup Grim Directory

sudo mkdir -p /opt/reaper
sudo chown $USER:$USER /opt/reaper

5. Build Go Binaries

cd /opt/reaper/go_grim
go mod download
make build

๐Ÿ“‹ System Requirements

Required System Tools

  • rsync - File synchronization
  • tar - Archive creation
  • gzip, bzip2, xz - Compression utilities
  • openssl - Encryption and certificates
  • curl, wget - File downloads
  • ssh, scp - Remote operations
  • find, du, df - System utilities

Required Runtime

  • Python 3.8+ - Core application logic
  • Go 1.21+ - High-performance components
  • Bash 4.0+ - System orchestration

Optional Dependencies

  • PostgreSQL - Database backend
  • Redis - Caching and sessions
  • MongoDB - Document storage

๐Ÿ”ง Dependency Management

How PyPI Handles Dependencies

The Grim Reaper package uses a hybrid dependency management approach:

โœ… What PyPI Manages

  • Python package dependencies (via install_requires)
  • Python console scripts (via entry_points)
  • Package data files (bash scripts, configs)

โŒ What Requires Manual Installation

  • System-level packages (apt, yum, etc.)
  • Go runtime and binaries
  • External system tools

Dependency Checking

The package includes built-in dependency checking:

# Check all dependencies
grim check-deps

# This will verify:
# - System tools (rsync, tar, gzip, etc.)
# - Go runtime
# - Go binaries
# - Python package integrity

๐Ÿ—๏ธ Architecture

Grim Reaper System
โ”œโ”€โ”€ Python Package (PyPI)
โ”‚   โ”œโ”€โ”€ grim_gateway.py    # Main entry point
โ”‚   โ”œโ”€โ”€ grim_web/          # Web interface
โ”‚   โ”œโ”€โ”€ grim_core/         # Core functionality
โ”‚   โ””โ”€โ”€ grim_monitor/      # Monitoring
โ”œโ”€โ”€ Go Components
โ”‚   โ”œโ”€โ”€ grim-compression   # High-performance compression
โ”‚   โ””โ”€โ”€ grim-encryption    # Encryption utilities
โ””โ”€โ”€ Bash Scripts
    โ”œโ”€โ”€ grim_throne.sh     # Main orchestrator
    โ”œโ”€โ”€ backup.sh          # Backup operations
    โ”œโ”€โ”€ monitor.sh         # System monitoring
    โ””โ”€โ”€ security.sh        # Security operations

๐Ÿ“ฆ Package Contents

Python Package (grim-reaper)

  • Entry Points: grim, grim-backup, grim-monitor, grim-scan, grim-health, scythe
  • Data Files: Bash scripts, configuration files, ASCII art
  • Dependencies: FastAPI, TuskLang SDK, PyYAML, aiohttp, bcrypt, etc.

Go Components (go_grim/)

  • Binary: grim-compression - High-performance compression engine
  • Dependencies: Managed via go.mod
  • Build: Requires Go 1.21+ and Make

Bash Scripts (sh_grim/)

  • Orchestrator: grim_throne.sh - Main command router
  • Operations: Backup, monitoring, security, AI integration
  • Dependencies: System utilities (rsync, tar, openssl, etc.)

๐Ÿš€ Usage

Basic Commands

# Show help
grim help

# Check system health
grim health

# Start backup
grim backup /path/to/backup

# Monitor system
grim monitor

# Security scan
grim scan /path/to/scan

# Check dependencies
grim check-deps

Advanced Usage

# Orchestrated backup with all systems
grim backup --source /home --dest /backups --compress --encrypt

# Real-time monitoring
grim monitor --interval 30 --metrics

# Security audit
grim scan --vulnerabilities --compliance

๐Ÿ” Troubleshooting

Common Issues

1. "grim_throne.sh not found"

# Ensure Grim directory exists
sudo mkdir -p /opt/reaper
sudo chown $USER:$USER /opt/reaper

# Reinstall package
pip install --force-reinstall grim-reaper

2. "Go binary not found"

# Build Go components
cd /opt/reaper/go_grim
make build

3. "System tool not found"

# Install missing system tools
sudo apt install rsync tar gzip bzip2 xz-utils openssl curl wget

4. "Permission denied"

# Fix permissions
sudo chown -R $USER:$USER /opt/reaper
chmod +x /opt/reaper/grim_throne.sh

Dependency Verification

# Comprehensive dependency check
grim check-deps

# Manual verification
which rsync tar gzip go grim-compression
ls -la /opt/reaper/grim_throne.sh

๐Ÿ“š Documentation

๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ†˜ Support


Grim Reaper - The Ultimate Backup, Monitoring, and Security System

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

grim_reaper-1.0.5.tar.gz (86.8 kB view details)

Uploaded Source

Built Distribution

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

grim_reaper-1.0.5-py3-none-any.whl (103.7 kB view details)

Uploaded Python 3

File details

Details for the file grim_reaper-1.0.5.tar.gz.

File metadata

  • Download URL: grim_reaper-1.0.5.tar.gz
  • Upload date:
  • Size: 86.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for grim_reaper-1.0.5.tar.gz
Algorithm Hash digest
SHA256 c17fb691bacb30685c14b3d90e435fedc2c525f886b6ed50edd8a30156b77bca
MD5 25458650b30e8836bee92263f385678f
BLAKE2b-256 cf80273c0993670b1f98665ea8780175898b10c3303676c27633dc7c986edeac

See more details on using hashes here.

File details

Details for the file grim_reaper-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: grim_reaper-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 103.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for grim_reaper-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 80d57319cd07de8f769f8676b21152b75d699bc49394a5ae4c0f1a1ca5c38eb4
MD5 5c6e635339bade8aead28728c465ecd7
BLAKE2b-256 9d8089adf863eb65d67cdbf6871dbcb3a17ecbe4137fb46401f2f622b3049a13

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