Back to .md Directory

Gemini Project Context: ScryFall-UI

Provides Gemini AI with project context, structure, and workflow for assisting with a Magic: The Gathering desktop app.

May 2, 2026
0 downloads
1 views
ai gemini workflow
View source

What this file does

Provides Gemini AI with project context, structure, and workflow for assisting with a Magic: The Gathering desktop app.

When to use it

  • Onboarding a new AI assistant to the codebase
  • Setting up a Gemini context file for any Python GUI project
  • Documenting API integrations and project layout for collaborators

Assumes this stack

PythonScryfall APIArchidekt APIpipenv

Gemini Project Context: ScryFall-UI

This file provides context for the Gemini AI assistant to understand and effectively assist with this project.

Project Overview

This project is a Python-based desktop application with a graphical user interface (GUI). Its primary purpose is to interact with the Scryfall and Archidekt APIs. Users can likely search for Magic: The Gathering cards, view card details (including images), and manage or view decklists from Archidekt.

Key Technologies

  • Language: Python
  • APIs:
    • Scryfall: For Magic: The Gathering card data and images. The core logic is likely in core/scryfall_api.py.
    • Archidekt: For decklist fetching and management. Test files like test_archidekt.py suggest its integration.
  • GUI Framework: A Python GUI framework is used (e.g., Tkinter, PyQt, PySide). The specific framework can be identified by inspecting the imports in the ui/ directory files.
  • Dependencies: Managed via Pipfile (using pipenv) and a requirements.txt is also present.

Project Structure

  • main.py: The main entry point for the application.
  • core/: Contains the core application logic, separated from the UI.
    • scryfall_api.py: Handles interactions with the Scryfall API.
    • image_loader.py: Manages downloading and caching card images.
  • ui/: Contains all GUI-related code.
    • main_window.py: The main application window.
    • detail_window.py: A window to show specific card details.
  • utils/: Contains helper functions and other utilities.
  • resources/cache/: Caching directory, likely for images to reduce API calls.
  • test_*.py: Python test files, suggesting the use of a framework like pytest.

Development Workflow

  • Running the application: The application is likely started by running python main.py.
  • Managing Dependencies: To add or remove dependencies, pipenv should be used, which will update Pipfile and Pipfile.lock. requirements.txt may need to be regenerated afterwards (e.g., pipenv lock -r > requirements.txt).
  • Running Tests: Based on the file naming convention, tests can likely be run using the pytest command from the project root.

What's inside

5 sections: overview, technologies, structure, workflow, and key files list

Change this for your project

  • Replace MrFlou/ScryFall-UI with your own repository name
  • Replace core/scryfall_api.py with your actual API module path
  • Replace ui/main_window.py with your main window file path

Where it goes

Keep it in your repository where the agent or team that needs it will read it.

Related Documents