Setup

scooze can be used without a database to gain access to robust data models for representing cards and decks.

Using scooze for its data models

from scooze import Card, Deck, Format, InThe

deck = Deck()
card1 = Card("Python")
card2 = Card("Anaconda")
swamp = Card("Swamp")

deck.add_card(card1, 25)
deck.add_card(swamp, 15)
deck.add_card(card2, 100, InThe.SIDE)

legal_limited = deck.is_legal(Format.LIMITED)   # True
legal_pauper = deck.is_legal(Format.PAUPER)     # False

export = deck.export()
"""
Deck:
25 Python
15 Swamp

Sideboard:
100 Anaconda
"""

To take advantage of all the features scooze has to offer, you'll need to decide how you want to setup your database.

Database Setup¶

Option 1: Using Docker¶

Make sure Docker is running.

Using scooze in your docker-compose.yml

services:
scooze:
    image: "arcavios/scooze:latest"
    environment:
    - MONGO_HOST=mongodb
    ports:
    - "8000:8000"
mongodb:
    image: "mongo:latest"
    ports:
    - "27017:27017"

This will automatically call scooze run to start the REST API for you, so you can skip to "Using The CLI" below.

Option 2: Running Local MongoDB¶

scooze depends on MongoDB to run your local database. Download and install MongoDB.

Note

Your local database can be stored wherever you want, but make sure you create the directory first. This is commonly stored at /data/db

Run the MongoDB server like this:

mongod --dbpath path/to/db/

Option 2, Part 2: Starting the REST API¶

scooze does not come pre-loaded with any data. You can load data from Scryfall by using the CLI as described in the section below. For a simple UI to interact with your database, you can start the REST API with

scooze run

then visit localhost:8000 (this port is configurable in your docker-compose.yml)

Using the CLI¶

Run the scooze command line interface tool to add some data to your local database.

Using the scooze CLI

scooze -h
scooze load cards --oracle

Using scooze in Your Code¶

Now that you've got some cards in your database, you can use it in your own code!

Using scooze in your code

from scooze import Color, ScoozeApi

with ScoozeApi() as s:
    # get 10 arbitrary green cards
    green_cards = s.get_cards_by("colors", [Color.GREEN], paginated=True, page_size=10)
    # get _all_ green cards
    green_cards = s.get_cards_by("colors", [Color.GREEN])

    # get all cards from a particular set
    woe_cards = s.get_cards_by_set("woe")

    # get a specific card
    black_lotus = s.get_card_by_name("Black Lotus")
    print(black_lotus.total_words())

    # and more!