Simulchip

Contents:

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Development Installation
    • Verify Installation
  • Quick Start Guide
    • Installation
    • Using the CLI
    • Basic Library Usage
      • Initialize Components
      • Managing Your Collection
      • Comparing Decklists
      • Generating PDF Proxies
    • CLI Reference
    • New Library Features
    • Building Custom Tools
  • API Reference
    • NetrunnerDB API Client
      • CardData
        • CardData.code
        • CardData.title
        • CardData.type_code
        • CardData.faction_code
        • CardData.pack_code
        • CardData.quantity
        • CardData.deck_limit
        • CardData.image_url
        • CardData.code
        • CardData.title
        • CardData.type_code
        • CardData.faction_code
        • CardData.pack_code
        • CardData.quantity
        • CardData.deck_limit
        • CardData.image_url
      • PackData
        • PackData.code
        • PackData.name
        • PackData.position
        • PackData.cycle_code
        • PackData.cycle
        • PackData.date_release
        • PackData.code
        • PackData.name
        • PackData.position
        • PackData.cycle_code
        • PackData.cycle
        • PackData.date_release
      • DecklistData
        • DecklistData.id
        • DecklistData.name
        • DecklistData.description
        • DecklistData.cards
        • DecklistData.id
        • DecklistData.name
        • DecklistData.description
        • DecklistData.cards
      • APIError
        • APIError.message
        • APIError.status_code
        • APIError.url
        • APIError.message
        • APIError.status_code
        • APIError.url
        • APIError.__init__()
      • NetrunnerDBAPI
        • NetrunnerDBAPI.BASE_URL
        • NetrunnerDBAPI.DEFAULT_RATE_LIMIT
        • NetrunnerDBAPI.rate_limit_delay
        • NetrunnerDBAPI.cache
        • NetrunnerDBAPI.BASE_URL
        • NetrunnerDBAPI.DEFAULT_RATE_LIMIT
        • NetrunnerDBAPI.__init__()
        • NetrunnerDBAPI.get_all_cards()
        • NetrunnerDBAPI.get_all_packs()
        • NetrunnerDBAPI.check_cache_validity()
        • NetrunnerDBAPI.check_cache_validity_with_reason()
        • NetrunnerDBAPI.set_offline_mode()
        • NetrunnerDBAPI.is_offline_mode()
        • NetrunnerDBAPI.get_packs_by_release_date()
        • NetrunnerDBAPI.get_card_by_code()
        • NetrunnerDBAPI.get_all_printings()
        • NetrunnerDBAPI.get_cycle_name_mapping()
        • NetrunnerDBAPI.get_decklist()
        • NetrunnerDBAPI.get_pack_by_code()
        • NetrunnerDBAPI.get_cards_by_pack()
        • NetrunnerDBAPI.refresh_cache()
    • Collection Management
      • Manager
        • CollectionData
        • PackSummary
        • CollectionError
        • CardRequirement
        • APIClient
        • CollectionManager
      • Operations
        • get_reset_items()
        • get_or_create_manager()
        • sort_cards_by_title()
        • get_packs_by_release_date()
    • PDF Generation
      • ProxyPDFGenerator
        • ProxyPDFGenerator.CARD_WIDTH
        • ProxyPDFGenerator.CARD_HEIGHT
        • ProxyPDFGenerator.PAGE_MARGIN
        • ProxyPDFGenerator.CARD_SPACING
        • ProxyPDFGenerator.CARD_WIDTH
        • ProxyPDFGenerator.CARD_HEIGHT
        • ProxyPDFGenerator.PAGE_MARGIN
        • ProxyPDFGenerator.CARD_SPACING
        • ProxyPDFGenerator.__init__()
        • ProxyPDFGenerator.generate_proxy_pdf()
        • ProxyPDFGenerator.generate_pack_pdf()
    • Utilities
      • FactionCode
        • FactionCode.ANARCH
        • FactionCode.CRIMINAL
        • FactionCode.SHAPER
        • FactionCode.ADAM
        • FactionCode.APEX
        • FactionCode.SUNNY_LEBEAU
        • FactionCode.HAAS_BIOROID
        • FactionCode.JINTEKI
        • FactionCode.NBN
        • FactionCode.WEYLAND
        • FactionCode.NEUTRAL_CORP
        • FactionCode.NEUTRAL_RUNNER
        • FactionCode.__new__()
        • FactionCode.__format__()
      • extract_decklist_id()
      • get_faction_symbol()
      • format_card_count()
      • sanitize_filename()
      • get_faction_short_name()
      • parse_card_code()
      • format_deck_size()
      • get_faction_side()
      • CardInfo
        • CardInfo.code
        • CardInfo.title
        • CardInfo.pack_code
        • CardInfo.pack_name
        • CardInfo.type_code
        • CardInfo.faction_code
        • CardInfo.required_count
        • CardInfo.owned_count
        • CardInfo.missing_count
        • CardInfo.is_identity
        • CardInfo.is_fully_owned
        • CardInfo.ownership_ratio
        • CardInfo.__init__()
      • DecklistStats
        • DecklistStats.total_cards
        • DecklistStats.owned_cards
        • DecklistStats.missing_cards
        • DecklistStats.unique_cards
        • DecklistStats.unique_owned
        • DecklistStats.unique_missing
        • DecklistStats.completion_percentage
        • DecklistStats.is_complete
        • DecklistStats.__init__()
      • ComparisonResult
        • ComparisonResult.decklist_id
        • ComparisonResult.decklist_name
        • ComparisonResult.identity
        • ComparisonResult.stats
        • ComparisonResult.cards_by_pack
        • ComparisonResult.cards_by_faction
        • ComparisonResult.missing_cards
        • ComparisonResult.owned_cards
        • ComparisonResult.all_cards
        • ComparisonResult.identity_title
        • ComparisonResult.identity_faction
        • ComparisonResult.total_cards
        • ComparisonResult.owned_cards_count
        • ComparisonResult.missing_cards_count
        • ComparisonResult.missing_by_pack
        • ComparisonResult.owned_by_pack
        • ComparisonResult.__init__()
      • DecklistComparisonError
      • DecklistComparer
        • DecklistComparer.IDENTITY_TYPE_CODE
        • DecklistComparer.__init__()
        • DecklistComparer.compare_decklist()
        • DecklistComparer.get_proxy_cards()
        • DecklistComparer.get_proxy_cards_for_generation()
        • DecklistComparer.format_comparison_report()
        • DecklistComparer.get_pack_requirements()
      • CacheManager
        • CacheManager.__init__()
        • CacheManager.get_cached_cards()
        • CacheManager.cache_cards()
        • CacheManager.get_cached_packs()
        • CacheManager.cache_packs()
        • CacheManager.get_card_image_path()
        • CacheManager.has_card_image()
        • CacheManager.get_card_image()
        • CacheManager.download_and_cache_image()
        • CacheManager.clear_cache()
        • CacheManager.get_cache_stats()
        • CacheManager.get_cache_metadata()
        • CacheManager.update_cache_metadata()
        • CacheManager.get_latest_pack_date()
        • CacheManager.is_cache_valid()
        • CacheManager.mark_cache_fresh()
    • CLI Utilities
      • resolve_collection_path()
      • ensure_collection_directory()
      • ensure_output_directory()
      • validate_collection_exists()
      • should_generate_proxies()
      • get_proxy_generation_message()
      • filter_valid_packs()
      • calculate_collection_stats()
      • validate_pack_selection()
      • get_navigation_page_size()
      • calculate_selection_bounds()
      • should_reset_selection_on_filter_change()
      • get_card_quantity_action()
      • should_ignore_pack_toggle_errors()
      • NavigationConfig
        • NavigationConfig.__init__()
        • NavigationConfig.get_viewport_padding()
    • Display Utilities
      • calculate_viewport_size()
      • calculate_viewport_window()
      • format_viewport_status()
      • get_completion_color()
    • Filtering and Search
      • filter_packs()
      • filter_packs_raw()
      • filter_cards()
      • filter_cards_raw()
      • create_pack_filter()
      • create_card_filter()
      • filter_items_generic()
    • Interactive Interface Management
      • KeyAction
        • KeyAction.UP
        • KeyAction.DOWN
        • KeyAction.PAGE_UP
        • KeyAction.PAGE_DOWN
        • KeyAction.TOP
        • KeyAction.BOTTOM
        • KeyAction.SELECT
        • KeyAction.TOGGLE
        • KeyAction.INCREMENT
        • KeyAction.DECREMENT
        • KeyAction.SET_VALUE
        • KeyAction.RESET
        • KeyAction.FILTER_ADD_CHAR
        • KeyAction.FILTER_BACKSPACE
        • KeyAction.FILTER_CLEAR
        • KeyAction.SAVE_AND_EXIT
        • KeyAction.CANCEL
        • KeyAction.TOGGLE_MODE
        • KeyAction.HELP
        • KeyAction.UNKNOWN
      • InteractiveState
        • InteractiveState.selected_index
        • InteractiveState.filter_text
        • InteractiveState.mode_flags
        • InteractiveState.viewport_start
        • InteractiveState.viewport_end
        • InteractiveState.total_items
        • InteractiveState.__post_init__()
        • InteractiveState.reset_selection()
        • InteractiveState.update_viewport()
        • InteractiveState.set_filter()
        • InteractiveState.toggle_mode()
        • InteractiveState.__init__()
      • KeyMapper
        • KeyMapper.ESCAPE_SEQUENCES
        • KeyMapper.SINGLE_CHARS
        • KeyMapper.__init__()
        • KeyMapper.map_key()
      • process_navigation_action()
      • process_filter_action()
      • InteractiveController
        • InteractiveController.__init__()
        • InteractiveController.process_key()
    • Data Models and Wrappers
      • FilterableItem
        • FilterableItem.get_id()
        • FilterableItem.matches_filter()
        • FilterableItem.__init__()
      • PackModel
        • PackModel.__init__()
        • PackModel.get_id()
        • PackModel.matches_filter()
      • CardModel
        • CardModel.__init__()
        • CardModel.get_id()
        • CardModel.matches_filter()
        • CardModel.is_identity
      • filter_items()
    • Path Management
      • get_default_collection_path()
      • get_default_cache_dir()
      • get_deck_pdf_path()
      • create_identity_slug()
      • ensure_path_exists()
      • get_cache_subdirectory()
      • get_cache_locations()
      • reset_simulchip_data()
      • generate_default_output_path()
    • Platform-Specific Utilities
      • InputHandler
        • InputHandler.get_char()
        • InputHandler.__init__()
      • UnixInputHandler
        • UnixInputHandler.get_char()
      • WindowsInputHandler
        • WindowsInputHandler.get_char()
      • get_input_handler()
      • is_interactive_terminal()
      • get_platform_name()
      • getch()
    • Core Modules
  • Contributing
    • Development Setup
    • Code Style
    • Contribution Guidelines
    • Submitting Changes
    • Testing
    • Documentation
    • Code of Conduct
Simulchip
  • Python Module Index

Python Module Index

s
 
s
- simulchip
    simulchip.api.netrunnerdb
    simulchip.cache
    simulchip.cli_utils
    simulchip.collection.manager
    simulchip.collection.operations
    simulchip.comparison
    simulchip.display
    simulchip.filters
    simulchip.interactive
    simulchip.models
    simulchip.paths
    simulchip.pdf.generator
    simulchip.platform
    simulchip.utils

© Copyright 2025, Simulchip Contributors.

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