https://github.com/silvanocerza/mkm-sdk

Python SDK for Magickartenmarkt API
https://github.com/silvanocerza/mkm-sdk

api api-rest api-wrapper magic mtg mtg-api pokemon python requests tcg wow yugioh

Last synced: about 2 months ago
JSON representation

Python SDK for Magickartenmarkt API

• Host: GitHub
• URL: https://github.com/silvanocerza/mkm-sdk
• Owner: silvanocerza
• License: mit
• Created: 2023-07-24T21:04:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-01T16:08:14.000Z (over 1 year ago)
• Last Synced: 2025-02-13T20:07:27.630Z (2 months ago)
• Topics: api, api-rest, api-wrapper, magic, mtg, mtg-api, pokemon, python, requests, tcg, wow, yugioh
• Language: Python
• Homepage:
• Size: 134 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Magic Kard Market Python SDK

[![image](https://badge.fury.io/py/mkmsdk.png)](http://badge.fury.io/py/mkmsdk)

[![image](https://readthedocs.org/projects/mkm-sdk/badge/?version=latest)](http://mkm-sdk.readthedocs.org/en/latest/)

[![image](https://coveralls.io/repos/evonove/mkm-sdk/badge.svg)](https://coveralls.io/r/evonove/mkm-sdk)

[![image](https://travis-ci.org/evonove/mkm-sdk.svg)](https://travis-ci.org/evonove/mkm-sdk)

A simple SDK for dedicated and widget apps working with Magic Kard

Market.

# Contributing

Feel free to contribute! Submit [a PR following the

guidelines](https://mkm-sdk.readthedocs.io/en/latest/contributing.html#pull-request-guidelines/)

and it will be alright.

# Requirements

-   Python 3.8, 3.9, 3.10, 3.11

-   [Requests](http://docs.python-requests.org/)

-   [Requests_OAuthlib](https://github.com/requests/requests-oauthlib/)

# Setup

From the command line:

    pip install mkmsdk

For the SDK to work properly you need to create four environment

variables holding the tokens necessary to create the authorization to

make requests. You can find them in your Magic Kard Market account page

under the apps section.

-   `MKM_APP_TOKEN`

-   `MKM_APP_SECRET`

-   `MKM_ACCESS_TOKEN`

-   `MKM_ACCESS_TOKEN_SECRET`

[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}

need to be set to empty string if you want to use a widget app.

# Usage

First thing to do is import the [Mkm]{.title-ref} class and the API map:

    from mkmsdk.mkm import Mkm

    from mkmsdk.api_map import _API_MAP

Instance a new instance of Mkm:

    # Using API v1.1

    mkm = Mkm(_API_MAP["1.1"]["api"], _API_MAP["1.1"]["api_root"])

    # Using API v2.0

    mkm = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_root"])

If you want to test on Magic Card Market\'s sandbox you must use the

sandbox root endpoint:

    mkm_sandbox = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_sandbox_root"])

To make a request:

    response = mkm.account_management.account()

    # Formats an endpoint

    response = mkm.market_place.user(user='SampleUser')

    # Call endpoint with specified parameters

    response = mkm.account_management.vacation(params={"onVacation": "false"})

This will return a

[Response](http://docs.python-requests.org/en/latest/api/?highlight=response#requests.Response/)

object that contains the response from the server.

Note that only [market_place]{.title-ref} requests work when using a

widget app.

To get a json you can call response.json().

# Tests

Integration tests will be skipped if the four environment variables are

not set.

-   `MKM_APP_TOKEN`

-   `MKM_APP_SECRET`

-   `MKM_ACCESS_TOKEN`

-   `MKM_ACCESS_TOKEN_SECRET`

Note that some tests will be skipped depending if

[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}

are empty strings or not.