muban-cli 1.0.0__tar.gz

muban_cli-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+*.log
+*.pdf
+temp/
+.vscode/
+.venv/
+.coverage
+__pycache__/
+.pytest_cache/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/

muban_cli-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,110 @@
+stages:
+  - test
+  - build
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+
+# Cache pip packages between jobs
+cache:
+  key: ${CI_COMMIT_REF_SLUG}
+  paths:
+    - .cache/pip
+    - .venv/
+
+# Test job - runs on all branches
+test:
+  stage: test
+  image: python:3.11-slim
+  tags:
+    - docker
+  before_script:
+    - python -m venv .venv
+    - source .venv/bin/activate
+    - pip install --upgrade pip
+    - pip install -e ".[dev]"
+  script:
+    - pytest tests/ -v --tb=short --junitxml=report.xml
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+    expire_in: 1 week
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_COMMIT_BRANCH
+
+# Test with coverage - runs on main/master and MRs
+test:coverage:
+  stage: test
+  image: python:3.11-slim
+  tags:
+    - docker
+  before_script:
+    - python -m venv .venv
+    - source .venv/bin/activate
+    - pip install --upgrade pip
+    - pip install -e ".[dev]"
+  script:
+    - pytest tests/ -v --cov=muban_cli --cov-report=xml --cov-report=term-missing
+  coverage: '/TOTAL.*\s+(\d+%)/'
+  artifacts:
+    when: always
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+    expire_in: 1 week
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+# Test multiple Python versions
+.test-matrix:
+  stage: test
+  tags:
+    - docker
+  before_script:
+    - python -m venv .venv
+    - source .venv/bin/activate
+    - pip install --upgrade pip
+    - pip install -e ".[dev]"
+  script:
+    - pytest tests/ -v --tb=short
+
+test:py39:
+  extends: .test-matrix
+  image: python:3.9-slim
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+test:py310:
+  extends: .test-matrix
+  image: python:3.10-slim
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+test:py312:
+  extends: .test-matrix
+  image: python:3.12-slim
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+# Build package
+build:
+  stage: build
+  image: python:3.11-slim
+  tags:
+    - docker
+  before_script:
+    - pip install build
+  script:
+    - python -m build
+  artifacts:
+    paths:
+      - dist/
+    expire_in: 1 week
+  rules:
+    - if: $CI_COMMIT_TAG
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

muban_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 muban-cli contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

muban_cli-1.0.0/PKG-INFO

@@ -0,0 +1,518 @@
+Metadata-Version: 2.4
+Name: muban-cli
+Version: 1.0.0
+Summary: Command-line interface for Muban Document Generation Service
+Author-email: Muban Team <contact@muban.me>
+Maintainer-email: Muban Team <contact@muban.me>
+License: MIT
+Project-URL: Homepage, https://muban.me
+Project-URL: Documentation, https://muban.me/features.html
+Keywords: muban,jasperreports,document-generation,cli,pdf,reporting,templates
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: urllib3>=1.26.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: responses>=0.23.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-requests>=2.28.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Dynamic: license-file
+
+# Muban CLI
+
+A robust command-line interface for the **Muban Document Generation Service**. Manage JasperReports templates and generate documents directly from your terminal.
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Secure Authentication** - JWT token-based auth with credential login
+- **Template Management** - List, upload, download, and delete templates
+- **Document Generation** - Generate PDF, XLSX, DOCX, RTF, and HTML documents
+- **Search & Filter** - Search templates and filter audit logs
+- **Audit & Monitoring** - Access audit logs and security dashboards (admin)
+- **Automation Ready** - Perfect for CI/CD pipelines and scripting
+- **Cross-Platform** - Works on Windows, macOS, and Linux
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install muban-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/muban/muban-cli.git
+cd muban-cli
+pip install -e .
+```
+
+### Development Installation
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### 1. Configure the Server
+
+```bash
+# Interactive setup
+muban configure
+
+# Or with command-line options
+muban configure --server https://api.muban.me
+```
+
+### 2. Login with Your Credentials
+
+```bash
+# Interactive login (prompts for username/password)
+muban login
+
+# Or with command-line options
+muban login --username your@email.com
+```
+
+### 3. List Available Templates
+
+```bash
+muban list
+```
+
+### 4. Generate a Document
+
+```bash
+muban generate TEMPLATE_ID -p title="Monthly Report" -p date="2025-01-08"
+```
+
+## Configuration
+
+### Configuration File
+
+Configuration is stored in `~/.muban/config.json`. JWT tokens are stored separately in `~/.muban/credentials.json` with restricted permissions.
+
+### Environment Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `MUBAN_TOKEN` | JWT Bearer token (obtained via `muban login`) |
+| `MUBAN_SERVER_URL` | API server URL (default: <https://api.muban.me>) |
+| `MUBAN_AUTH_SERVER_URL` | Auth server URL (if different from API server) |
+| `MUBAN_TIMEOUT` | Request timeout in seconds |
+| `MUBAN_VERIFY_SSL` | Enable/disable SSL verification |
+| `MUBAN_CONFIG_DIR` | Custom configuration directory |
+
+Environment variables take precedence over configuration files.
+
+## Commands Reference
+
+### Authentication
+
+```bash
+# Login with credentials (interactive)
+muban login
+
+# Login with username provided
+muban login --username admin@example.com
+
+# Login with custom server
+muban login --server https://api.muban.me
+
+# Check authentication status (shows token expiry)
+muban whoami
+
+# Manually refresh access token
+muban refresh
+
+# Logout (clear all tokens)
+muban logout
+```
+
+**Token Refresh:**
+
+- If the server provides a refresh token, it's automatically stored
+- The CLI automatically refreshes expired tokens when making API requests
+- Use `muban refresh` to manually refresh before expiration
+- Use `muban whoami` to see token expiration time
+
+### Configuration Commands
+
+```bash
+# Interactive configuration
+muban configure
+
+# Set server URL
+muban configure --server https://api.muban.me
+
+# Set auth server (if different from API server)
+muban configure --auth-server https://auth.muban.me
+
+# Show current configuration
+muban configure --show
+
+# Clear all configuration
+muban config-clear
+```
+
+### Template Management
+
+```bash
+# List all templates
+muban list
+muban list --search "invoice" --format json
+muban list --page 2 --size 50
+
+# Search templates
+muban search "quarterly report"
+
+# Get template details
+muban get TEMPLATE_ID
+muban get TEMPLATE_ID --params  # Show parameters
+muban get TEMPLATE_ID --fields  # Show fields
+
+# Upload a template (ZIP format)
+muban push report.zip --name "Monthly Report" --author "John Doe"
+muban push invoice.zip -n "Invoice" -a "Finance Team" -m "Standard invoice template"
+
+# Download a template
+muban pull TEMPLATE_ID
+muban pull TEMPLATE_ID -o ./templates/report.zip
+
+# Delete a template
+muban delete TEMPLATE_ID
+muban delete TEMPLATE_ID --yes  # Skip confirmation
+```
+
+### Document Generation
+
+```bash
+# Basic generation
+muban generate TEMPLATE_ID -p title="Sales Report"
+
+# Multiple parameters
+muban generate TEMPLATE_ID -p title="Report" -p year=2025 -p amount=15750.25
+
+# Different output formats
+muban generate TEMPLATE_ID -F xlsx -o report.xlsx
+muban generate TEMPLATE_ID -F docx -o report.docx
+muban generate TEMPLATE_ID -F html -o report.html
+
+# Using parameter file
+muban generate TEMPLATE_ID --params-file params.json
+
+# Using JSON data source
+muban generate TEMPLATE_ID --data-file data.json
+
+# PDF options
+muban generate TEMPLATE_ID --pdf-pdfa PDF/A-1b --locale pl_PL
+muban generate TEMPLATE_ID --pdf-password secret123
+
+# Output options
+muban generate TEMPLATE_ID -o ./output/report.pdf --filename "Sales_Report_Q4"
+```
+
+**Parameter File Format (params.json):**
+
+```json
+{
+  "title": "Monthly Sales Report",
+  "year": 2025,
+  "department": "Finance"
+}
+```
+
+Or as a list:
+
+```json
+[
+  {"name": "title", "value": "Monthly Sales Report"},
+  {"name": "year", "value": 2025}
+]
+```
+
+**Data Source File Format (data.json):**
+
+```json
+{
+  "items": [
+    {"productName": "Widget A", "quantity": 100, "unitPrice": 25.50},
+    {"productName": "Widget B", "quantity": 50, "unitPrice": 45.00}
+  ],
+  "summary": {
+    "totalItems": 150,
+    "totalValue": 4800.00
+  }
+}
+```
+
+### Utility Commands
+
+```bash
+# List available fonts
+muban fonts
+
+# List ICC color profiles (for PDF export)
+muban icc-profiles
+```
+
+### Admin Commands
+
+```bash
+# Verify template integrity
+muban admin verify-integrity TEMPLATE_ID
+
+# Regenerate integrity digest
+muban admin regenerate-digest TEMPLATE_ID
+
+# Regenerate all digests
+muban admin regenerate-all-digests --yes
+
+# Get server configuration
+muban admin server-config
+```
+
+### Audit Commands
+
+```bash
+# View audit logs
+muban audit logs
+muban audit logs --severity HIGH --since 1d
+muban audit logs --event-type LOGIN_FAILURE --format json
+
+# Get audit statistics
+muban audit statistics --since 7d
+
+# View security events
+muban audit security --since 24h
+
+# Dashboard and monitoring
+muban audit dashboard
+muban audit threats
+muban audit health
+
+# List available event types
+muban audit event-types
+
+# Trigger cleanup
+muban audit cleanup --yes
+```
+
+### Common Options
+
+All commands support these options:
+
+| Option      | Short | Description                   |
+|-------------|-------|-------------------------------|
+| `--verbose` | `-v`  | Enable verbose output         |
+| `--quiet`   | `-q`  | Suppress non-essential output |
+| `--format`  | `-f`  | Output format (table, json)   |
+| `--help`    |       | Show help message             |
+
+## CI/CD Integration
+
+### GitHub Actions Example
+
+```yaml
+name: Deploy Report Template
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'templates/**'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+      
+      - name: Install Muban CLI
+        run: pip install muban-cli
+      
+      - name: Deploy Template
+        env:
+          MUBAN_TOKEN: ${{ secrets.MUBAN_TOKEN }}
+          MUBAN_SERVER_URL: https://api.muban.me
+        run: |
+          cd templates
+          zip -r report.zip ./monthly_report/
+          muban push report.zip --name "Monthly Report" --author "CI/CD"
+```
+
+### GitLab CI Example
+
+```yaml
+deploy_template:
+  image: python:3.9-slim
+  stage: deploy
+  only:
+    changes:
+      - templates/**
+  script:
+    - pip install muban-cli
+    - cd templates && zip -r report.zip ./monthly_report/
+    - muban push report.zip --name "Monthly Report" --author "GitLab CI"
+  variables:
+    MUBAN_TOKEN: $MUBAN_TOKEN
+    MUBAN_SERVER_URL: https://api.muban.me
+```
+
+### Shell Script Example
+
+```bash
+#!/bin/bash
+# deploy-template.sh
+
+set -e
+
+TEMPLATE_DIR="./my_jasper_project"
+TEMPLATE_NAME="Monthly Sales Report"
+AUTHOR="Deploy Script"
+
+# Create ZIP archive
+zip -r template.zip "$TEMPLATE_DIR"
+
+# Upload to Muban
+muban push template.zip \
+  --name "$TEMPLATE_NAME" \
+  --author "$AUTHOR" \
+  --metadata "Deployed from commit ${GIT_COMMIT:-unknown}"
+
+# Cleanup
+rm template.zip
+
+echo "Template deployed successfully!"
+```
+
+## Error Handling
+
+The CLI provides detailed error messages and appropriate exit codes:
+
+| Exit Code | Meaning |
+| --------- | ------- |
+| 0 | Success |
+| 1 | General error |
+| 130 | Interrupted (Ctrl+C) |
+
+### Common Errors
+
+```bash
+# Not configured
+$ muban list
+✗ Muban CLI is not configured.
+  Run 'muban configure' to set up your server, then 'muban login'.
+
+# Not authenticated
+$ muban list
+✗ Not authenticated. Run 'muban login' to sign in.
+
+# Template not found
+$ muban get invalid-id
+✗ Template not found: invalid-id
+
+# Permission denied
+$ muban delete some-template
+✗ Permission denied. Manager role required.
+```
+
+## Development
+
+### Running Tests
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=muban_cli --cov-report=html
+```
+
+### Code Quality
+
+```bash
+# Format code
+black muban_cli
+isort muban_cli
+
+# Type checking
+mypy muban_cli
+
+# Linting
+flake8 muban_cli
+```
+
+### Project Structure
+
+```text
+muban-cli/
+├── muban_cli/
+│   ├── __init__.py      # Package initialization
+│   ├── cli.py           # CLI commands (Click)
+│   ├── api.py           # REST API client
+│   ├── config.py        # Configuration management
+│   ├── utils.py         # Utility functions
+│   ├── exceptions.py    # Custom exceptions
+│   └── py.typed         # PEP 561 marker
+├── tests/               # Test suite
+├── pyproject.toml       # Project configuration
+└── README.md            # Documentation
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- Email: <contact@muban.me>
+- Documentation: <https://muban.me/features.html>
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request