Assets Guardian (0.2.0)

Guides

  • ๐Ÿ›ก๏ธ Assets Guardian
    • ๐Ÿ”Œ Available Plugins
    • ๐Ÿš€ Quick Start
      • 1. Install the command
      • 2. Prepare an audit folder
      • 3. Run it
    • ๐Ÿ“œ License
  • ๐Ÿš€ Getting started
    • ๐Ÿ“ฆ Installation
      • ๐Ÿ”— Clone the repository
      • ๐Ÿ Standalone install
        • Installation
        • Upgrade
        • Uninstall
      • ๐Ÿ Local dev
      • ๐Ÿณ Docker image (use)
      • ๐Ÿ’ป Dev Container
      • ๐Ÿณ Docker image (develop)
    • โš™๏ธ Setup configurations
      • ๐Ÿ“ Configuration Files
      • ๐Ÿ“‘ File Details
        • ๐Ÿ“„ The config.yml file
        • ๐Ÿ”‘ Environment variables
        • ๐Ÿ“„ The template.config.yml file
        • ๐Ÿ“„ The rules_config.yml file
        • ๐Ÿ“„ The employees.json file
        • ๐Ÿ“„ The excel_config.json file
        • ๐Ÿ“„ The pdf_config.json file
    • โ–ถ๏ธ Running
      • ๐Ÿ›ก๏ธ Assets Guardian commands
      • ๐Ÿงช Power-user scripts
      • โ–ถ๏ธ Running by mode
        • ๐Ÿ Standalone (with assets-guardian)
        • ๐Ÿ Local dev (with uv)
        • ๐Ÿณ Docker image (use)
        • ๐Ÿ’ป Dev Container (VS Code)
        • ๐Ÿณ Docker image (develop)
  • ๐Ÿ” Access Matrix Guide
    • ๐Ÿงญ How matrices work
      • ๐Ÿ”„ Lifecycle
      • ๐Ÿท๏ธ Sheet naming
      • ๐Ÿ“ Sheet layout
      • ๐ŸŽฏ Matching rules
      • โš™๏ธ Enabling the matrix rules
      • ๐Ÿงฉ Interpretation is plugin-specific
    • ๐ŸฆŠ GitLab matrix
      • ๐Ÿ—‚๏ธ Scope columns
      • ๐Ÿ”ค Accepted cell values
      • โš–๏ธ Evaluation semantics
      • ๐Ÿ“ Example
    • ๐Ÿ’ผ Dolibarr matrix
      • ๐Ÿ—‚๏ธ Scope columns
      • ๐Ÿ”ค Accepted cell values
      • โš–๏ธ Evaluation semantics
      • ๐Ÿ“ Example
    • โ˜๏ธ Microsoft 365 matrix
      • ๐Ÿ—‚๏ธ Scope columns
      • ๐Ÿ”ค Accepted cell values
      • โš–๏ธ Evaluation semantics
      • ๐Ÿ“ Example
    • โœ… Filling checklist
  • ๐Ÿ—๏ธ Software Architecture Documentation
    • What is Assets Guardian?
    • System Overview
    • Startup Sequence - Plugin Discovery
    • Commands and Data Flows
      • sync - Update the Excel repository
      • audit - Compliance audit and PDF report
      • check - Configuration health check
      • script - Power-user custom scripts
    • Domain Models
    • Plugin System
      • What a plugin contains
      • Plugin interfaces
      • Registration via decorators
      • Multi-instance support
    • Design Patterns
      • Hexagonal Architecture (Ports and Adapters)
      • Registry and Factory
      • Template Method (Collector base class)
      • Strategy (Compliance rules)
      • Dependency Injection
      • Cache (JSON Lines)
    • Configuration Reference
      • config/config.yml - Main configuration
      • config/rules_config.yml - Compliance rules
      • config/employees.json - HR reference
    • Key Technical Decisions
  • ๐Ÿงฉ Plugin Development Guide
    • Architecture Overview
      • Key Design Principles
    • Plugin Directory Structure
    • Core Interfaces (Required)
      • IClientProvider
      • IRepository
      • IMapper
      • Collector
    • Optional Interfaces
      • ISheetBuilder (Sync Mode)
      • IRule (Audit Mode)
      • IPDFBuilder (Audit Mode)
    • Registries & Registration
      • Naming rule IDs
    • JSON Excel Configuration (Generic Sheet Builder)
      • JSON Configuration Structure
      • Available Configuration Options
        • Sheet Level
        • Column Level
        • Columns required by the round-trip
      • Rules & Formatting Reference
        • List Validation (Dropdowns)
        • Conditional Formatting
    • Configuration Workflow
      • Auditing Rules Setup
    • Plugin Lifecycle & Data Flow
    • Complete Example (myplugin)
      • plugins/myplugin/constants.py
      • plugins/myplugin/client.py
      • plugins/myplugin/repository.py
      • plugins/myplugin/mapper.py
      • plugins/myplugin/collector.py
    • Troubleshooting & Common Pitfalls
      • Plugin is not registered or discovered
      • Health check fails or crashes the application
      • Columns disappear during Excel sync regeneration
    • Testing & Validation Checklist
  • ๐Ÿค Contributing
    • ๐Ÿ™‹ What Can I Contribute?
      • ๐Ÿ› Reporting a Bug
      • ๐Ÿ’ก Requesting a Feature
      • ๐Ÿ”ง Fixing Something
      • ๐Ÿ“– Improving the Documentation
      • ๐Ÿงฉ Adding a Plugin
      • ๐Ÿ—๏ธ Refactoring the Core
    • ๐Ÿ’ป Contributing Code
      • ๐ŸŒณ Branching Model
      • ๐Ÿ› ๏ธ Set Up Your Environment
      • ๐ŸŒฟ Branch Naming
      • ๐Ÿ“ Commit Messages
      • โœ… Code Quality
        • ๐Ÿ Pytest Details
      • โœ๏ธ Code Documentation
    • ๐Ÿ”€ Opening a Pull Request
    • ๐Ÿ“š Contributing Documentation
    • ๐Ÿš€ Release Process
      • ๐Ÿท๏ธ Cutting a release
    • ๐Ÿ†˜ Getting Help
  • ๐Ÿ“œ Code of Conduct
    • ๐Ÿค Our Pledge
    • โœ… Our Standards
    • ๐Ÿ›ก๏ธ Enforcement Responsibilities
    • ๐ŸŒ Scope
    • ๐Ÿ“ข Reporting & Enforcement
    • ๐Ÿ“„ Attribution
  • ๐Ÿšจ Security Policy
    • ๐Ÿท๏ธ Supported Versions
    • ๐Ÿ“ข Reporting a Vulnerability

Code Reference

  • CLI โ€” Command Line Interface
    • assets-guardian
      • audit
      • check
      • script
      • sync
  • Domain โ€” Business Core
    • assets_guardian.core.domain.models
      • assets_guardian.core.domain.models.access
        • Access
      • assets_guardian.core.domain.models.asset
        • Asset
      • assets_guardian.core.domain.models.context
        • AssetsGuardianMode
        • Context
      • assets_guardian.core.domain.models.finding
        • Finding
        • RuleCategory
        • SeverityType
      • assets_guardian.core.domain.models.identity
        • Identity
        • IdentityState
        • IdentityType
      • assets_guardian.core.domain.models.location
        • Location
        • PathType
      • assets_guardian.core.domain.models.report
        • Report
      • assets_guardian.core.domain.models.rules
        • assets_guardian.core.domain.models.rules.comparison
        • assets_guardian.core.domain.models.rules.compliance
        • assets_guardian.core.domain.models.rules.matrix
        • assets_guardian.core.domain.models.rules.rule
      • assets_guardian.core.domain.models.validator
        • validate_field()
    • assets_guardian.core.domain.ports
      • assets_guardian.core.domain.ports.client
        • IClientProvider
      • assets_guardian.core.domain.ports.collector
        • Collector
      • assets_guardian.core.domain.ports.mapper
        • IMapper
      • assets_guardian.core.domain.ports.pdf_builders
        • IPDFBuilder
      • assets_guardian.core.domain.ports.repository
        • IRepository
      • assets_guardian.core.domain.ports.sheet_builders
        • ISheetBuilder
    • assets_guardian.core.domain.engines
      • assets_guardian.core.domain.engines.audit_engine
        • AuditEngine
      • assets_guardian.core.domain.engines.check_engine
        • CheckEngine
      • assets_guardian.core.domain.engines.collector_engine
        • CollectorEngine
        • CollectorResult
      • assets_guardian.core.domain.engines.compliance_engine
        • ComplianceEngine
      • assets_guardian.core.domain.engines.excel_engine
        • ExcelEngine
      • assets_guardian.core.domain.engines.pdf_engine
        • PdfEngine
      • assets_guardian.core.domain.engines.sync_engine
        • SyncEngine
  • Plugins โ€” Integrations
    • assets_guardian.plugins.gitlab
      • assets_guardian.plugins.gitlab.client
        • GitlabClientProvider
      • assets_guardian.plugins.gitlab.collector
        • GitlabCollector
      • assets_guardian.plugins.gitlab.compare
        • GitlabDeletedUserComparisonRule
        • GitlabNewUserComparisonRule
        • GitlabUserPrivilegeComparisonRule
        • GitlabUserStatusComparisonRule
        • index_users()
      • assets_guardian.plugins.gitlab.compliance
        • GitlbabUnknownMailComplianceRule
      • assets_guardian.plugins.gitlab.constants
      • assets_guardian.plugins.gitlab.mapper
        • GitlabMapper
      • assets_guardian.plugins.gitlab.matrix
        • GitlabGroupProjectAccessRule
        • InstanceAdminRule
      • assets_guardian.plugins.gitlab.repository
        • GitlabRepository
      • assets_guardian.plugins.gitlab.rules
    • assets_guardian.plugins.microsoft365
      • assets_guardian.plugins.microsoft365.client
        • Microsoft365ClientProvider
      • assets_guardian.plugins.microsoft365.collector
        • Microsoft365Collector
      • assets_guardian.plugins.microsoft365.compare
        • Microsoft365DeletedUserComparisonRule
        • Microsoft365NewUserComparisonRule
        • Microsoft365UserStatusComparisonRule
        • Microsoft365UserUserMfaComparaisonRule
        • index_users()
      • assets_guardian.plugins.microsoft365.compliance
        • Microsoft365UnknownMailComplianceRule
        • Microsoft365UserPrivilegeComplianceRule
      • assets_guardian.plugins.microsoft365.constants
      • assets_guardian.plugins.microsoft365.license_utils
        • get_license_name()
      • assets_guardian.plugins.microsoft365.mapper
        • Microsoft365Mapper
      • assets_guardian.plugins.microsoft365.matrix
        • Microsoft365GroupProjectAccessRule
      • assets_guardian.plugins.microsoft365.repository
        • Microsoft365Repository
      • assets_guardian.plugins.microsoft365.rules
    • assets_guardian.plugins.dolibarr
      • assets_guardian.plugins.dolibarr.client
        • DolibarrClientProvider
      • assets_guardian.plugins.dolibarr.collector
        • DolibarrCollector
      • assets_guardian.plugins.dolibarr.compare
        • DolibarrDeletedUserComparisonRule
        • DolibarrNewUserComparisonRule
      • assets_guardian.plugins.dolibarr.compliance
        • DolibarrDeactivatedUsersRule
        • DolibarrUnknownMailComplianceRule
      • assets_guardian.plugins.dolibarr.constants
        • get_permission_label()
      • assets_guardian.plugins.dolibarr.mapper
        • DolibarrMapper
      • assets_guardian.plugins.dolibarr.matrix
        • DolibarrCriticalModuleAccessRule
        • DolibarrSuperadminRule
      • assets_guardian.plugins.dolibarr.repository
        • DolibarrRepository
      • assets_guardian.plugins.dolibarr.rules
    • assets_guardian.plugins.teleport
  • Reporting โ€” Excel, PDF
    • assets_guardian.core.reporting.excel
      • assets_guardian.core.reporting.excel.default_builder
        • DefaultSheetBuilder
      • assets_guardian.core.reporting.excel.generic_parser
        • parse_workbook_data()
      • assets_guardian.core.reporting.excel.reader
        • read_workbook()
      • assets_guardian.core.reporting.excel.rules_loader
        • load_rules()
      • assets_guardian.core.reporting.excel.sheets_builder
        • GenericSheetBuilder
      • assets_guardian.core.reporting.excel.writer
        • ExcelWorksheet
        • ExcelWriter
    • assets_guardian.core.reporting.pdf
      • assets_guardian.core.reporting.pdf.rules_loader
        • load_rules()
      • assets_guardian.core.reporting.pdf.writer
        • AGPDF
        • PDFWriter
  • Clients โ€” HTTP, MySQL
    • assets_guardian.core.clients
      • assets_guardian.core.clients.http_client
        • HttpClient
      • assets_guardian.core.clients.microsoft_client
        • MicrosoftGraph
      • assets_guardian.core.clients.mysql_client
        • MySQLClient
  • Plumbing โ€” Config, Logging, Cache
    • assets_guardian.core.config
      • assets_guardian.core.config.app_config
        • AppConfig
        • AppEnv
      • assets_guardian.core.config.author_config
        • AuthorConfig
      • assets_guardian.core.config.cache_config
        • CacheConfig
      • assets_guardian.core.config.loader
        • browse_dict()
        • get_config_value()
        • get_env_key_name()
        • get_project_version()
        • load_employees_profiles()
        • load_json()
        • load_profiles()
        • load_yaml_config()
        • to_str_list()
      • assets_guardian.core.config.logging_config
        • LoggingConfig
      • assets_guardian.core.config.paths_config
        • PathsConfig
      • assets_guardian.core.config.validator
        • validate_config()
    • assets_guardian.core.logging
      • assets_guardian.core.logging.logger
        • ColorFormatter
        • get_plugin_logger()
        • init_logging()
    • assets_guardian.core.cache
      • assets_guardian.core.cache.cache
        • CacheManager
        • LazyCacheIterable
  • Utils โ€” Dates, IP
    • assets_guardian.utils
      • assets_guardian.utils.dates
        • add_date_to_filename()
        • format_datetime()
        • parse_datetime()
      • assets_guardian.utils.ip
        • get_ip_location()
        • get_my_ip()
        • parse_ip()
      • assets_guardian.utils.timer
Assets Guardian (0.2.0)
  • Plugins โ€” Integrations
  • assets_guardian.plugins.gitlab
  • View page source

assets_guardian.plugins.gitlab๏ƒ

Modules

client

collector

compare

compliance

constants

mapper

matrix

repository

rules

Previous Next

© Copyright 2026, Apizee.

Built with Sphinx using a theme provided by Read the Docs.