Skip to main content

Magic: the Gathering decklist parser

Project description

mtg-parser

PyPI PyPI - Python Version Github - Nightly Check GitHub

mtg_parser is a Python library to download and parse Magic The Gathering decklists. It supports the most popular decklists hosting websites.

The following section covers the installation of mtg_parser.

Table of contents

Installation

The following section covers the installation of mtg_parser.

Before using mtg_parser, you will need:

  • python >= 3.8.1

To install mtg_parser, simply run one of the following commands in the terminal of your choice:

$ pip install mtg-parser

or

$ poetry add mtg-parser

Supported Formats

In addition to MTGO and MTGA formats, mtg_parser supports the following websites:

Known issues

Moxfield

moxfield.com prevents the scraping of their website (it's against their Terms of Service). Please contact support@moxfield.com if you want to proceed anyway.

Usage

Start by importing the mtg_parser module:

import mtg_parser

Now let's parse a decklist (in any of the supported formats) and display the cards:

cards = mtg_parser.parse_deck(url)
for card in cards:
	print(card)

mtg_parser.parse_deck() is a shortcut method to the specialized versions. Provided that url is a valid Moxfield url, the following lines are equivalent:

cards = mtg_parser.parse_deck(url)
# is the same as:
cards = mtg_parser.moxfield.parse_deck(url)

In general, it's advised to use mtg_parser.parse_deck() as the overhead is insignificant.

If for any reason, you need to configure how mtg_parser is fetching remote decklists, you can provide an optional requests.Session object.

from requests import Session

s = Session()
# Configure your session here
cards = mtg_parser.parse_deck(url, session=s)
for card in cards:
	print(card)

Parsing textual decklist

mtg_parser can parse textual decklists in either MTGO or MTGA format

import mtg_parser

decklist = """
	1 Atraxa, Praetors' Voice
	1 Imperial Seal
	1 Lim-Dûl's Vault
	1 Jeweled Lotus (CMR) 319
	1 Llanowar Elves (M12) 182
	3 Brainstorm #Card Advantage #Draw
"""

cards = mtg_parser.decklist.parse_deck(deck_list)
for card in cards:
	print(card)

Parsing decklists from aetherhub.com

mtg_parser can parse public decks from aetherhub.com

import mtg_parser

url = 'https://aetherhub.com/Deck/<deck_name>'

cards = mtg_parser.aetherhub.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from archidekt.com

mtg_parser can parse public decks from archidekt.com

import mtg_parser

url = 'https://www.archidekt.com/decks/<deck_id>/'

cards = mtg_parser.archidekt.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from deckstats.net

mtg_parser can parse public decks from deckstats.net

import mtg_parser

url = 'https://deckstats.net/decks/<userid>/<deck_id>'

cards = mtg_parser.deckstats.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from moxfield.com

mtg_parser can parse public decks from moxfield.com

import mtg_parser

url = 'https://www.moxfield.com/decks/<deck_id>'

cards = mtg_parser.moxfield.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from mtggoldfish.com

mtg_parser can parse public decks from mtggoldfish.com

import mtg_parser

url = 'https://www.mtggoldfish.com/deck/<deck_id>'

cards = mtg_parser.mtggoldfish.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from mtgjson.com

mtg_parser can parse decks from mtgjson.com

import mtg_parser

url = 'https://mtgjson.com/api/v5/decks/<deck_name>.json'

cards = mtg_parser.mtgjson.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from scryfall.com

mtg_parser can parse public decks from scryfall.com

import mtg_parser

url = 'https://scryfall.com/<userid>/decks/<deck_id>/'

cards = mtg_parser.scryfall.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from tappedout.net

mtg_parser can parse public decks from tappedout.net

import mtg_parser

url = 'https://tappedout.net/mtg-decks/<deck_id>/'

cards = mtg_parser.tappedout.parse_deck(url)
for card in cards:
	print(card)

Parsing decklists from tcgplayer.com

mtg_parser can parse public decks from tcgplayer.com

import mtg_parser

url = 'https://decks.tcgplayer.com/magic/<deck_path>'

cards = mtg_parser.tcgplayer.parse_deck(url)
for card in cards:
	print(card)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mtg_parser-0.0.1a36.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

mtg_parser-0.0.1a36-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file mtg_parser-0.0.1a36.tar.gz.

File metadata

  • Download URL: mtg_parser-0.0.1a36.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.5.0

File hashes

Hashes for mtg_parser-0.0.1a36.tar.gz
Algorithm Hash digest
SHA256 66f4877f9e8b811aa287f47ea11a54ed19a61aaf9be996f6e79d3842c108a359
MD5 4ede87850efda20b72445b738a3e97b7
BLAKE2b-256 24c732e4e6db2e94e95dc6ccd389909a9477a4a663f7c27a0c8d8ce18dd6609e

See more details on using hashes here.

File details

Details for the file mtg_parser-0.0.1a36-py3-none-any.whl.

File metadata

  • Download URL: mtg_parser-0.0.1a36-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.5.0

File hashes

Hashes for mtg_parser-0.0.1a36-py3-none-any.whl
Algorithm Hash digest
SHA256 100cc6950d89de852b32fb8931bea8ad36afb6bd1e7a639891b90a34eb3255d8
MD5 d1575b894ae0bb1d87499eed92c4457c
BLAKE2b-256 75759c77c0483138c7b88c6471d040d88fac118c3478427ea0215850e95371a0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page