Merge pull request #79 from Tsukalos/master
Added new classes to fetch keywords and ability words from catalog on the API
This commit is contained in:
commit
6d7a0016ad
|
@ -0,0 +1,66 @@
|
||||||
|
# **class** `scrython.catalog.AbilityWords()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`AbilityWords().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.KeywordAbilities()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,66 @@
|
||||||
|
# **class** `scrython.catalog.KeywordAbilities()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`KeywordAbilities().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.KeywordAbilities()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,66 @@
|
||||||
|
# **class** `scrython.catalog.KeywordActions()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`KeywordActions().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.KeywordActions()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -33,6 +33,10 @@ from scrython.catalog import Toughnesses
|
||||||
from scrython.catalog import Watermarks
|
from scrython.catalog import Watermarks
|
||||||
from scrython.catalog import WordBank
|
from scrython.catalog import WordBank
|
||||||
from scrython.catalog import ArtistNames
|
from scrython.catalog import ArtistNames
|
||||||
|
from scrython.catalog import KeywordAbilities
|
||||||
|
from scrython.catalog import KeywordActions
|
||||||
|
from scrython.catalog import AbilityWords
|
||||||
|
|
||||||
|
|
||||||
#Import symbology
|
#Import symbology
|
||||||
from scrython.symbology import ParseMana
|
from scrython.symbology import ParseMana
|
||||||
|
@ -77,4 +81,7 @@ __all__ = [
|
||||||
'Symbology',
|
'Symbology',
|
||||||
'BulkData',
|
'BulkData',
|
||||||
'ScryfallError',
|
'ScryfallError',
|
||||||
|
'KeywordAbilities',
|
||||||
|
'KeywordActions',
|
||||||
|
'AbilityWords'
|
||||||
]
|
]
|
||||||
|
|
|
@ -11,6 +11,9 @@ from .toughnesses import Toughnesses
|
||||||
from .watermarks import Watermarks
|
from .watermarks import Watermarks
|
||||||
from .word_bank import WordBank
|
from .word_bank import WordBank
|
||||||
from .artist_names import ArtistNames
|
from .artist_names import ArtistNames
|
||||||
|
from .keyword_abilities import KeywordAbilities
|
||||||
|
from .keyword_actions import KeywordActions
|
||||||
|
from .ability_words import AbilityWords
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
'ArtifactTypes',
|
'ArtifactTypes',
|
||||||
|
@ -25,5 +28,8 @@ __all__ = [
|
||||||
'Toughnesses',
|
'Toughnesses',
|
||||||
'Watermarks',
|
'Watermarks',
|
||||||
'WordBank',
|
'WordBank',
|
||||||
'ArtistNames'
|
'ArtistNames',
|
||||||
|
'KeywordAbilities',
|
||||||
|
'KeywordActions',
|
||||||
|
'AbilityWords'
|
||||||
]
|
]
|
|
@ -0,0 +1,26 @@
|
||||||
|
from .catalogs_object import CatalogsObject
|
||||||
|
|
||||||
|
|
||||||
|
class AbilityWords(CatalogsObject):
|
||||||
|
"""
|
||||||
|
catalogs/ability-words
|
||||||
|
|
||||||
|
Catalog object for all known ability words
|
||||||
|
|
||||||
|
Args:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
>>> catalog = scrython.catalog.KeywordAbilities()
|
||||||
|
>>> catalog.data()
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._url = 'catalog/ability-words?'
|
||||||
|
super(AbilityWords, self).__init__(self._url)
|
|
@ -0,0 +1,26 @@
|
||||||
|
from .catalogs_object import CatalogsObject
|
||||||
|
|
||||||
|
|
||||||
|
class KeywordAbilities(CatalogsObject):
|
||||||
|
"""
|
||||||
|
catalog/keyword-abilities
|
||||||
|
|
||||||
|
Catalog object for all known keyword abilities
|
||||||
|
|
||||||
|
Args:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
>>> catalog = scrython.catalog.KeywordAbilities()
|
||||||
|
>>> catalog.data()
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._url = 'catalog/keyword-abilities?'
|
||||||
|
super(KeywordAbilities, self).__init__(self._url)
|
|
@ -0,0 +1,26 @@
|
||||||
|
from .catalogs_object import CatalogsObject
|
||||||
|
|
||||||
|
|
||||||
|
class KeywordActions(CatalogsObject):
|
||||||
|
"""
|
||||||
|
catalog/keyword-actions
|
||||||
|
|
||||||
|
Catalog object for all known keyword actions
|
||||||
|
|
||||||
|
Args:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
N/A
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
>>> catalog = scrython.catalog.KeywordActions()
|
||||||
|
>>> catalog.data()
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._url = 'catalog/keyword-actions?'
|
||||||
|
super(KeywordActions, self).__init__(self._url)
|
Loading…
Reference in New Issue