Modules API

Modules principaux

• Module main
  • report()
  • signup()
  • create()
  • generate()
  • debug()
  • version()
  • main()

• Module report_manager
  • ReportType
    • ReportType.USERS_VMS
    • ReportType.STATUS
    • ReportType.ALL
  • ReportFormat
    • ReportFormat.JSON
    • ReportFormat.MARKDOWN
    • ReportFormat.HTML
    • ReportFormat.ALL
  • generate_reports()

• Module vm_manager
  • create_vm()
  • create_vm_cli()

Modules reports

• Module reports.base
  • BaseReportGenerator
    • BaseReportGenerator.__init__()
    • BaseReportGenerator.generate()
    • BaseReportGenerator.get_extension()

• Module reports.html_reports
  • HTMLReportGenerator
    • HTMLReportGenerator.__init__()
    • HTMLReportGenerator.get_extension()
    • HTMLReportGenerator.generate()
    • HTMLReportGenerator.generate_users_vms_report()
    • HTMLReportGenerator.generate_status_report()

• Module reports.json_reports
  • JSONReportGenerator
    • JSONReportGenerator.__init__()
    • JSONReportGenerator.get_extension()
    • JSONReportGenerator.generate()
    • JSONReportGenerator.generate_users_vms_report()
    • JSONReportGenerator.generate_api_summary_report()

• Module reports.markdown_reports
  • MarkdownReportGenerator
    • MarkdownReportGenerator.__init__()
    • MarkdownReportGenerator.get_extension()
    • MarkdownReportGenerator.generate()
    • MarkdownReportGenerator.generate_users_vms_report()
    • MarkdownReportGenerator.generate_status_report()

Modules scripts

• Module scripts.create_data_via_api
  • display_header()
  • display_api_config()
  • display_operation_config()
  • display_batch_progress()
  • display_success_message()
  • display_error_message()
  • display_statistics()
  • display_preview()
  • display_dataset_saved()
  • display_api_status()
  • create_users_via_api()
  • create_vms_via_api()
  • users()
  • vms()
  • full_dataset()
  • status()
  • version()
  • main()

• Module scripts.deploy_docs
  • run_command()
  • main()

• Module scripts.fix_pdoc3_syntax
  • find_code_blocks()
  • convert_code_block()
  • fix_file()
  • main()

• Module scripts.generate_data
  • users_with_vms()
  • vms_only()
  • preview()
  • version()
  • main()

• Module scripts.generate_docs
  • run_command()
  • main()

• Module scripts.quick_cleanup
  • display_header()
  • display_api_config()
  • display_operation_config()
  • display_simulation_message()
  • connect_to_api()
  • fetch_data()
  • display_vms_table()
  • display_users_table()
  • display_deletion_progress()
  • display_deletion_result()
  • display_pause_message()
  • display_success_message()
  • delete_vm_data()
  • delete_user_data()
  • delete_items_batch()
  • delete_items_with_progress()
  • delete_items_with_progress_and_global()
  • delete_single_vm_with_display()
  • delete_single_user_with_display()
  • cleanup_data()
  • show_summary()
  • quick_cleanup()
  • cleanup()
  • main()

Modules utils

• Module utils.config
  • load_env_files()
  • Config
    • Config.__init__()
    • Config.is_production
    • Config.has_credentials
    • Config.has_token
    • Config.auth_headers
    • Config.client_config
    • Config.to_dict()
    • Config.__str__()
    • Config.save_to_env_file()
    • Config.update_token()
    • Config.__repr__()

• Module utils.data_generator
  • VMDataGenerator
    • VMDataGenerator.OPERATING_SYSTEMS
    • VMDataGenerator.VM_STATUSES
    • VMDataGenerator.STATUS_PROBABILITIES
    • VMDataGenerator.generate_vm_name()
    • VMDataGenerator.generate_cpu_cores()
    • VMDataGenerator.generate_ram_gb()
    • VMDataGenerator.generate_disk_gb()
    • VMDataGenerator.generate_status()
    • VMDataGenerator.generate_vm()
  • UserDataGenerator
    • UserDataGenerator.COMPANY_DOMAINS
    • UserDataGenerator.generate_email()
    • UserDataGenerator.generate_user()
  • DataGenerator
    • DataGenerator.generate_users_with_vms()
    • DataGenerator.generate_vms_only()

• Module utils.date_utils
  • parse_unix_timestamp()

• Module utils.logging_config
  • setup_logging()
  • get_logger()

• Module utils.password_utils
  • get_password_from_config()
  • get_password_from_input()
  • get_password()
  • get_email_from_config()
  • get_email_from_input()
  • get_credentials_from_config()
  • get_credentials_from_input()
  • get_credentials()
  • get_token_from_config()
  • save_token_to_env()
  • remove_token_from_env()
  • get_or_create_token()

Modules utils/api

• Module utils.api.auth
  • Auth
    • Auth.__init__()
    • Auth.create_user()
    • Auth.login_user()
    • Auth.get_logged_user_info()

• Module utils.api.decorators
  • retry_on_429()

• Module utils.api.exceptions
  • DemoAPIException
    • DemoAPIException.__init__()
  • AuthenticationError
    • AuthenticationError.__init__()
  • UserCreationError
    • UserCreationError.__init__()
  • UserLoginError
    • UserLoginError.__init__()
  • UserInfoError
    • UserInfoError.__init__()
  • UsersFetchError
    • UsersFetchError.__init__()
  • VMsFetchError
    • VMsFetchError.__init__()
  • VMCreationError
    • VMCreationError.__init__()
  • TokenError
    • TokenError.__init__()
  • CredentialsError
    • CredentialsError.__init__()
  • NetworkError
    • NetworkError.__init__()
  • UserUpdateError
    • UserUpdateError.__init__()
  • UserDeleteError
    • UserDeleteError.__init__()
  • VMUpdateError
    • VMUpdateError.__init__()
  • VMDeleteError
    • VMDeleteError.__init__()
  • APIRequestError
    • APIRequestError.__init__()

• Module utils.api.user
  • get_users()
  • add_vms_to_users()
  • create_user()
  • get_user()
  • update_user()
  • delete_user()

• Module utils.api.vm
  • get_vms()
  • create_vm()
  • get_vm()
  • update_vm()
  • delete_vm()
  • attach_vm_to_user()
  • stop_vm()

Modules utils/services

• Module utils.services.data_manager
  • DataManager
    • DataManager.__init__()
    • DataManager.fetch_all_data()
    • DataManager.get_users()
    • DataManager.get_vms()
    • DataManager.get_users_with_vms()
    • DataManager.clear_cache()
    • DataManager.is_data_loaded

• Module utils.services.report_service
  • ReportService
    • ReportService.__init__()
    • ReportService.generate_users_vms_report()
    • ReportService.generate_status_report()
    • ReportService.generate_users_vms_report_markdown()
    • ReportService.generate_users_vms_report_html()
    • ReportService.generate_status_report_markdown()
    • ReportService.generate_status_report_html()

• Module utils.services.vm_service
  • VMService
    • VMService.__init__()
    • VMService.authenticate_user()
    • VMService.create_vm_for_user()
    • VMService.create_default_vm_for_user()