monorail
/
Scrython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Moved Scrython.md to be the README, deleted the original.

This commit is contained in:
Nanda Scott 2018-02-04 23:43:57 -05:00
parent 287eb203a6
commit 7b31641237
2 changed files with 33 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1 +1,33 @@
# Scrython # 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
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 `rulings`as of writing this. I hope to include more as this is developed.

33
docs/Scrython.md
View File

@ -1,33 +0,0 @@
# 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
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()
'*Remember to paste black lotus id*'
>>>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 `rulings`as of writing this. I hope to include more as this is developed.