infomankit 0.3.23__py3-none-any.whl

infoman/cli/templates/docker/README.md.template

@@ -0,0 +1,240 @@
+# Docker Configuration
+
+This directory contains Docker configuration files for {project_name}.
+
+## Files
+
+- `Dockerfile` - Multi-stage Docker image definition
+- `docker-compose.yml` - Docker Compose orchestration
+- `.dockerignore` - Files to exclude from Docker build
+- `mysql/conf.d/custom.cnf` - MySQL configuration
+- `mysql/init/01-init.sql` - Database initialization script
+
+## Quick Start
+
+### 1. Configure Environment
+
+Ensure `.env` file exists in project root with required variables:
+
+```bash
+# Copy from config directory
+cp config/.env.dev .env
+
+# Or create minimal .env
+cat > .env <<EOF
+APP_ENV=dev
+MYSQL_DB={project_name}_db
+MYSQL_USER={project_name}_user
+MYSQL_PASSWORD=your_password
+MYSQL_ROOT_PASSWORD=root_password
+EOF
+```
+
+### 2. Build and Start Services
+
+```bash
+# Build images
+docker-compose -f docker/docker-compose.yml build
+
+# Start all services
+docker-compose -f docker/docker-compose.yml up -d
+
+# View logs
+docker-compose -f docker/docker-compose.yml logs -f
+```
+
+### 3. Access Services
+
+- Application: http://localhost:8000
+- API Docs: http://localhost:8000/docs
+- MySQL: localhost:3306
+- Redis: localhost:6379
+
+### 4. Stop Services
+
+```bash
+# Stop services
+docker-compose -f docker/docker-compose.yml down
+
+# Stop and remove volumes
+docker-compose -f docker/docker-compose.yml down -v
+```
+
+## Services
+
+### App Service
+
+- FastAPI application
+- Auto-reload enabled for development
+- Health checks configured
+- Depends on MySQL and Redis
+
+### MySQL Service
+
+- MySQL 8.0
+- Persistent data volume
+- Custom configuration in `mysql/conf.d/`
+- Initialization scripts in `mysql/init/`
+- Health checks configured
+
+### Redis Service
+
+- Redis 7 (Alpine Linux)
+- Persistent data volume
+- Optional password protection
+- Health checks configured
+
+## Development Workflow
+
+### Run with auto-reload
+
+```bash
+docker-compose -f docker/docker-compose.yml up
+```
+
+The `app/` directory is mounted as a volume, so code changes are reflected immediately.
+
+### Execute commands in container
+
+```bash
+# Shell access
+docker-compose -f docker/docker-compose.yml exec app bash
+
+# Run tests
+docker-compose -f docker/docker-compose.yml exec app pytest
+
+# Database migrations
+docker-compose -f docker/docker-compose.yml exec app alembic upgrade head
+```
+
+### View logs
+
+```bash
+# All services
+docker-compose -f docker/docker-compose.yml logs -f
+
+# Specific service
+docker-compose -f docker/docker-compose.yml logs -f app
+docker-compose -f docker/docker-compose.yml logs -f mysql
+```
+
+## MySQL Configuration
+
+### Custom Configuration
+
+Edit `mysql/conf.d/custom.cnf` to customize MySQL settings:
+- Character sets
+- Buffer sizes
+- Connection limits
+- Logging options
+
+### Initialization Scripts
+
+Add `.sql` files to `mysql/init/` directory. They will run automatically on first container startup in alphabetical order.
+
+### Connect to MySQL
+
+```bash
+# From host
+mysql -h localhost -P 3306 -u {project_name}_user -p
+
+# From app container
+docker-compose -f docker/docker-compose.yml exec app mysql -h mysql -u {project_name}_user -p
+```
+
+## Redis Configuration
+
+Redis is configured with:
+- AOF persistence enabled
+- Optional password protection via `REDIS_PASSWORD` env var
+
+Connect to Redis:
+
+```bash
+# From host
+redis-cli -h localhost -p 6379
+
+# From app container
+docker-compose -f docker/docker-compose.yml exec app redis-cli -h redis
+```
+
+## Production Deployment
+
+For production:
+
+1. Use production `.env` file:
+   ```bash
+   cp config/.env.prod .env
+   ```
+
+2. Update docker-compose.yml:
+   - Remove volume mounts for code
+   - Use specific image tags
+   - Configure resource limits
+   - Set up proper secrets management
+
+3. Use Docker secrets or external secret management:
+   ```yaml
+   secrets:
+     mysql_password:
+       external: true
+   ```
+
+4. Configure reverse proxy (nginx, traefik) for HTTPS
+
+5. Set up monitoring and logging
+
+## Troubleshooting
+
+### Container won't start
+
+```bash
+# Check logs
+docker-compose -f docker/docker-compose.yml logs
+
+# Check container status
+docker-compose -f docker/docker-compose.yml ps
+```
+
+### Database connection errors
+
+```bash
+# Verify MySQL is healthy
+docker-compose -f docker/docker-compose.yml exec mysql mysqladmin ping
+
+# Check connection from app
+docker-compose -f docker/docker-compose.yml exec app ping mysql
+```
+
+### Reset everything
+
+```bash
+# Stop and remove all containers, networks, and volumes
+docker-compose -f docker/docker-compose.yml down -v
+
+# Rebuild from scratch
+docker-compose -f docker/docker-compose.yml build --no-cache
+docker-compose -f docker/docker-compose.yml up -d
+```
+
+## Volume Management
+
+### Backup database
+
+```bash
+# Backup
+docker-compose -f docker/docker-compose.yml exec mysql mysqldump -u root -p{project_name}_db > backup.sql
+
+# Restore
+docker-compose -f docker/docker-compose.yml exec -T mysql mysql -u root -p {project_name}_db < backup.sql
+```
+
+### Inspect volumes
+
+```bash
+# List volumes
+docker volume ls
+
+# Inspect specific volume
+docker volume inspect docker_mysql_data
+```

infoman/cli/templates/docker/docker-compose.yml.template

@@ -0,0 +1,81 @@
+version: '3.8'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+    container_name: {project_name}_app
+    ports:
+      - "8000:8000"
+    volumes:
+      - ../app:/app/app
+      - ../logs:/app/logs
+    environment:
+      - APP_ENV=${{APP_ENV:-dev}}
+      - MYSQL_HOST=mysql
+      - REDIS_HOST=redis
+    env_file:
+      - ../.env
+    depends_on:
+      mysql:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    networks:
+      - app_network
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s
+
+  mysql:
+    image: mysql:8.0
+    container_name: {project_name}_mysql
+    ports:
+      - "3306:3306"
+    environment:
+      MYSQL_ROOT_PASSWORD: ${{MYSQL_PASSWORD:-root_password}}
+      MYSQL_DATABASE: ${{MYSQL_DB:-{project_name}_db}}
+      MYSQL_USER: ${{MYSQL_USER:-{project_name}_user}}
+      MYSQL_PASSWORD: ${{MYSQL_PASSWORD:-user_password}}
+    volumes:
+      - mysql_data:/var/lib/mysql
+      - ./mysql/conf.d:/etc/mysql/conf.d
+      - ./mysql/init:/docker-entrypoint-initdb.d
+    networks:
+      - app_network
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-p${{MYSQL_PASSWORD:-root_password}}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  redis:
+    image: redis:7-alpine
+    container_name: {project_name}_redis
+    ports:
+      - "6379:6379"
+    command: redis-server --appendonly yes ${{REDIS_PASSWORD:+--requirepass}} ${{REDIS_PASSWORD}}
+    volumes:
+      - redis_data:/data
+    networks:
+      - app_network
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+networks:
+  app_network:
+    driver: bridge
+
+volumes:
+  mysql_data:
+  redis_data:

infoman/cli/templates/docker/mysql_custom.cnf.template

@@ -0,0 +1,42 @@
+[mysqld]
+# Character set
+character-set-server=utf8mb4
+collation-server=utf8mb4_unicode_ci
+
+# Connection
+max_connections=200
+max_connect_errors=100
+
+# Buffer sizes
+innodb_buffer_pool_size=256M
+innodb_log_file_size=64M
+innodb_log_buffer_size=16M
+
+# Performance
+innodb_flush_log_at_trx_commit=2
+innodb_flush_method=O_DIRECT
+innodb_file_per_table=1
+
+# Query cache (disabled in MySQL 8.0+)
+# query_cache_type=0
+# query_cache_size=0
+
+# Slow query log
+slow_query_log=1
+slow_query_log_file=/var/log/mysql/slow-query.log
+long_query_time=2
+
+# General log (disable in production)
+general_log=0
+general_log_file=/var/log/mysql/general.log
+
+# Binary log
+log_bin=/var/log/mysql/mysql-bin.log
+binlog_expire_logs_seconds=604800
+max_binlog_size=100M
+
+# Time zone
+default-time-zone='+00:00'
+
+[client]
+default-character-set=utf8mb4

infoman/cli/templates/docker/mysql_init.sql.template

@@ -0,0 +1,15 @@
+-- Database initialization script for {project_name}
+-- This script runs automatically when the MySQL container is first created
+
+-- Ensure utf8mb4 character set
+ALTER DATABASE {project_name}_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- Create example table (optional - remove if not needed)
+-- CREATE TABLE IF NOT EXISTS example (
+--     id INT AUTO_INCREMENT PRIMARY KEY,
+--     name VARCHAR(255) NOT NULL,
+--     created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+--     updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
+-- ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+-- Add any additional initialization SQL here

infoman/cli/templates/project/.env.example.template

@@ -0,0 +1 @@
+ENV=dev

infoman/cli/templates/project/.gitignore.template

@@ -0,0 +1,60 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environment
+venv/
+ENV/
+env/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Environment
+.env
+.env.local
+
+# Logs
+logs/
+*.log
+
+# Database
+*.db
+*.sqlite
+*.sqlite3
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docker
+docker-compose.override.yml

infoman/cli/templates/project/Makefile.template

@@ -0,0 +1,38 @@
+.PHONY: help dev test lint format clean
+
+help:
+	@echo "Available commands:"
+	@echo "  make dev          - Start development server"
+	@echo "  make test         - Run tests"
+	@echo "  make lint         - Run linter"
+	@echo "  make format       - Format code"
+	@echo "  make clean        - Clean temporary files"
+
+dev:
+	@echo "Starting development server..."
+	infoman-serve run app.app:app --reload --host 0.0.0.0 --port 8000
+
+test:
+	@echo "Running tests..."
+	pytest tests/ -v --cov=app
+
+lint:
+	@echo "Running linter..."
+	ruff check .
+	mypy app/
+
+format:
+	@echo "Formatting code..."
+	black .
+	ruff check --fix .
+
+clean:
+	@echo "Cleaning temporary files..."
+	find . -type d -name "__pycache__" -exec rm -rf {{}} +
+	find . -type f -name "*.pyc" -delete
+	find . -type f -name "*.pyo" -delete
+	find . -type d -name "*.egg-info" -exec rm -rf {{}} +
+	find . -type d -name ".pytest_cache" -exec rm -rf {{}} +
+	find . -type d -name ".ruff_cache" -exec rm -rf {{}} +
+	find . -type d -name ".mypy_cache" -exec rm -rf {{}} +
+	rm -rf dist/ build/

infoman/cli/templates/project/README.md.template

@@ -0,0 +1,137 @@
+# {project_name}
+
+FastAPI application built with [infomankit](https://github.com/ai-infoman/infoman-pykit).
+
+## Quick Start
+
+### 1. Setup Environment
+
+```bash
+# Copy environment config (or use the generated .env directly)
+cp config/.env.dev .env
+
+# Update database credentials and other settings in .env
+```
+
+### 2. Install Dependencies
+
+```bash
+pip install -e .
+```
+
+### 3. Run Application
+
+#### Development Mode (Foreground)
+```bash
+# Using make (recommended for development)
+make dev
+
+# Or using main.py
+python main.py
+
+# Or using infoman-serve directly
+infoman-serve --app app.app:application --reload
+```
+
+#### Service Mode (Background)
+```bash
+# Start as background service
+./service.sh start
+
+# Check service status
+./service.sh status
+
+# View logs
+./service.sh logs
+
+# Stop service
+./service.sh stop
+```
+
+### 4. Access API Documentation
+
+- Swagger UI: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+## Project Structure
+
+```
+{project_name}/
+├── app/                    # Application code
+│   ├── models/            # Database models
+│   ├── routers/           # API routes
+│   ├── services/          # Business logic
+│   ├── repository/        # Data access layer
+│   ├── utils/             # Utilities
+│   ├── static/            # Static files
+│   └── template/          # HTML templates
+├── config/                # Configuration files
+│   ├── .env.dev          # Development config
+│   └── .env.prod         # Production config
+├── doc/                   # Documentation
+├── logs/                  # Application logs
+├── main.py               # Entry point
+├── Makefile              # Development commands
+└── service.sh            # Service management script
+```
+
+## Development
+
+### Using Makefile (Development Tools)
+
+For **development** and **one-time** commands:
+
+```bash
+make help         # Show all available commands
+make dev          # Run development server (foreground)
+make test         # Run tests
+make lint         # Run linter
+make format       # Format code
+make clean        # Clean temporary files
+```
+
+### Using service.sh (Service Management)
+
+For **background service** management:
+
+```bash
+./service.sh start     # Start service in background
+./service.sh stop      # Stop service
+./service.sh restart   # Restart service
+./service.sh status    # Show service status
+./service.sh logs      # Follow application logs
+./service.sh errors    # Follow error logs
+```
+
+**When to use each:**
+- **Makefile**: Development, debugging, testing, code quality checks
+- **service.sh**: Running service in background (testing, staging environments)
+
+## Docker Support
+
+Generate Docker configuration:
+
+```bash
+infomankit docker
+```
+
+This creates a `docker/` directory with:
+- Dockerfile
+- docker-compose.yml
+- MySQL configuration
+- Database initialization scripts
+
+## Configuration
+
+Edit `.env` file to configure:
+- Database connection
+- JWT settings
+- CORS origins
+- Redis connection
+- Logging settings
+
+See `config/README.md` for detailed documentation.
+
+## License
+
+MIT

infoman/cli/templates/project/deploy.sh.template

@@ -0,0 +1,97 @@
+#!/bin/bash
+
+# Color definitions
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Print colored message
+print_message() {{
+    local color=$1
+    local message=$2
+    echo -e "${{color}}${{message}}${{NC}}"
+}}
+
+# Print usage
+print_usage() {{
+    echo "Usage: ./deploy.sh [command]"
+    echo ""
+    echo "Available commands:"
+    echo "  dev          - Start development server"
+    echo "  test         - Run tests"
+    echo "  lint         - Run linter"
+    echo "  format       - Format code"
+    echo "  clean        - Clean temporary files"
+    echo "  help         - Show this help message"
+}}
+
+# Development server
+cmd_dev() {{
+    print_message "$BLUE" "Starting development server..."
+    infoman-serve run app.app:app --reload --host 0.0.0.0 --port 8000
+}}
+
+# Run tests
+cmd_test() {{
+    print_message "$BLUE" "Running tests..."
+    pytest tests/ -v --cov=app
+}}
+
+# Run linter
+cmd_lint() {{
+    print_message "$BLUE" "Running linter..."
+    ruff check .
+    mypy app/
+}}
+
+# Format code
+cmd_format() {{
+    print_message "$BLUE" "Formatting code..."
+    black .
+    ruff check --fix .
+    print_message "$GREEN" "Code formatted successfully"
+}}
+
+# Clean temporary files
+cmd_clean() {{
+    print_message "$BLUE" "Cleaning temporary files..."
+    find . -type d -name "__pycache__" -exec rm -rf {{}} + 2>/dev/null
+    find . -type f -name "*.pyc" -delete 2>/dev/null
+    find . -type f -name "*.pyo" -delete 2>/dev/null
+    find . -type d -name "*.egg-info" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".pytest_cache" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".ruff_cache" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".mypy_cache" -exec rm -rf {{}} + 2>/dev/null
+    rm -rf dist/ build/ 2>/dev/null
+    print_message "$GREEN" "Cleanup completed"
+}}
+
+# Main command dispatcher
+case "$1" in
+    dev)
+        cmd_dev
+        ;;
+    test)
+        cmd_test
+        ;;
+    lint)
+        cmd_lint
+        ;;
+    format)
+        cmd_format
+        ;;
+    clean)
+        cmd_clean
+        ;;
+    help|--help|-h|"")
+        print_usage
+        ;;
+    *)
+        print_message "$RED" "Error: Unknown command '$1'"
+        echo ""
+        print_usage
+        exit 1
+        ;;
+esac