From ef744d82ed8dd70c224aea500b8201c2192e0fc8 Mon Sep 17 00:00:00 2001 From: tooomm Date: Mon, 26 Jun 2017 15:12:30 +0200 Subject: [PATCH] readme update (#59) [skip ci] * [ci skip] readme update - outdated requirements are now always linked to up-to-date file - added spoiler files to output list - rephrases * small tweak --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index af6bb02e..56d756f4 100644 --- a/README.md +++ b/README.md @@ -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 MTG Salvation, Scryfall, MythicSpoiler and Wizards to compile
+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))
+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:
+`spoiler.xml`, `{SETCODE}.xml`, `MPS_{SETCODE}.xml`,
+`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. +
-When run by travis, uploads all files to [files branch](https://github.com/Cockatrice/Magic-Spoiler/tree/files) +Add the desired .xml file to your customsets folder to make Cockatrice use it.