fork of https://github.com/NandaScott/Scrython/ which seems to be unmaintained
Go to file
Nanda Scott 91a5f04113 Refactored autocomplete to be more consistent with the rest of the library. 2018-02-13 16:35:01 -05:00
docs Added examples and updated docs. 2018-02-06 20:36:36 -05:00
examples Added examples and updated docs. 2018-02-06 20:36:36 -05:00
scrython Refactored autocomplete to be more consistent with the rest of the library. 2018-02-13 16:35:01 -05:00
.gitignore Modfied gitignore and setup.py 2018-02-05 23:19:56 -05:00
LICENSE Created a license, requirements, and a few other directories that'll be used later. 2018-01-04 20:22:08 -05:00
README.md Updated readme for pip instructions. 2018-02-05 23:22:15 -05:00
requirements.txt Moved files around for uploading to PyPI. 2018-02-05 22:32:12 -05:00
setup.py Updated setup for new version. 2018-02-06 20:13:18 -05:00

README.md

Scrython

Scrython is a wrapper for the Scryfall API, designed for an easier use. Make sure to familiarize yourself with the docs.

Breaking changes

Since Scryfall's API is constantly changing, this library will also be changing.

Versions will be broken down as such:

0: Overall library version 0.x: Changes that will break previous functionality 0.x.x: Changes that Scryfall has made to break functionality.

It's important to keep up to date with library changes, since it relies on how Scryfall has updated it's own API. If they change something, my library will potentially break or be outdated until a fix is patched.

Basic usage

You can install scrython by running pip install scrython. Note that it requires asyncio and aiohttp too.

Scrython can be imported using import scrython at the top of your code. I've written to library to attempt to be familiar for those who already use it. As such, modules like cards are named to reflect the endpoints found in api.scryfall.com/cards/and so on. For the most part I've kept all the class attributes the same as their key names, except for a few cases where I've found better functionality.

    >>>import scrython
    >>>card = scrython.cards.Named(fuzzy="Black Lotus")
    >>>card.name()
    'Black Lotus'
    >>>card.id()
    'bd8fa327-dd41-4737-8f19-2cf5eb1f7cdd'
    >>>card.oracle_text()
    '{T}, Sacrifice Black Lotus: Add three mana of any one color to your mana pool.'

Key features

  • Asyncronous requests. This library utilizes the asyncio and aiohttp libraries to ensure that requests are not blocked when used in asyncronous environments. There is no delay limiting when making a request, so be careful how many objects are created.
  • Full use of all endpoints in a given category. This library uses every endpoint within cards and rulingsas of writing this. I hope to include more as this is developed.