Leahnaya/Magic-Spoiler
1
0
Fork 0
mirror of https://github.com/Cockatrice/Magic-Spoiler.git synced 2026-03-21 17:54:59 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

readme update (#59) [skip ci]

Browse Source 
* [ci skip] readme update

- outdated requirements are now always linked to up-to-date file
- added spoiler files to output list
- rephrases

* small tweak
This commit is contained in:
tooomm 2017-06-26 15:12:30 +02:00 committed by tritoch
parent 0f77039fe7
commit ef744d82ed
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,9 +1,13 @@
# Magic-Spoiler [![Gitter Chat](https://img.shields.io/gitter/room/Cockatrice/Magic-Spoiler.svg)](https://gitter.im/Cockatrice/Magic-Spoiler) #
Magic-Spoiler is a python script to scrape MTG Salvation, Scryfall, MythicSpoiler and Wizards to compile a XML file (Cockatrice formatted) and a general application ready json file (mtgjson formatted).
Magic-Spoiler is a Python script to scrape <i>MTG Salvation</i>, <i>Scryfall</i>, <i>MythicSpoiler</i> and <i>Wizards</i> to compile<br>
XML files (Cockatrice formatted) and application-ready json files (mtgjson formatted) with information about spoiled cards from upcoming sets.
## Output [![Build Status](https://travis-ci.org/Cockatrice/Magic-Spoiler.svg?branch=master)](https://travis-ci.org/Cockatrice/Magic-Spoiler) ##
Just looking for XML or JSON files? [They're in our `files` branch!](https://github.com/Cockatrice/Magic-Spoiler/tree/files) ([History of changes](https://github.com/Cockatrice/Magic-Spoiler/commits/files))
Just looking for XML or JSON files? [They are in our `files` branch!](https://github.com/Cockatrice/Magic-Spoiler/tree/files)
When run by Travis, the script automatically updates the files and uploads new versions there. ([History of changes](https://github.com/Cockatrice/Magic-Spoiler/commits/files))<br>
Travis CI is run daily on a cron job basis.
## Errors ##
Noticed an error? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help!
@ -12,14 +16,7 @@ Noticed an error? Check out our [Contributing file](https://github.com/Cockatri
### Requirements ###
* Python 2.7
* Python Modules:
- requests==2.13.0
- feedparser
- lxml
- Pillow
- datetime
- commentjson
- beautifulsoup4
* several Python Modules (see [requirements.txt](https://github.com/Cockatrice/Magic-Spoiler/blob/master/requirements.txt))
```
pip install -r requirements.txt
@ -31,10 +28,12 @@ pip install -r requirements.txt
$> python main.py
```
Outputs out/{SETCODE}.xml, out/MPS\_{SETCODE}.xml, out/{SETCODE}.json, out/MPS\_{SETCODE}.json
Outputs the following files to `out/` directory:<br>
`spoiler.xml`, `{SETCODE}.xml`, `MPS_{SETCODE}.xml`,<br>
`spoiler.json`, `{SETCODE}.json`, `MPS_{SETCODE}.json`
errors are logged to out/errors.json
Errors are logged there as well (`errors.json`)
Add the set xml file to your `customsets` folder for Cockatrice.
<br>
When run by travis, uploads all files to [files branch](https://github.com/Cockatrice/Magic-Spoiler/tree/files)
Add the desired <b>.xml</b> file to your <i>customsets</i> folder to make Cockatrice use it.