Merge pull request #70 from alecrem/chore/issue-68/update-readme

README.md

@@ -6,20 +6,24 @@ app_file: "Middle_School_Card_Search.py"
 
 # middleschool-cardlist
 
-Composes a list of Magic cards legal in the Middle School format
+Composes a list of Magic cards legal in the Middle School format.
 
 ## List of Middle School legal cards
 
 You can download the list in the following formats:
 
-- [JSON](output/middleschool.json)
-- [CSV](output/middleschool.csv)
+- [JSON (Oracle IDs and card names only)](output/middleschool.json)
+- [CSV (Oracle IDs and card names only)](output/middleschool.csv)
+- [JSON (with additional columns)](output/middleschool_extra_fields.json)
+- [CSV (with additional columns)](output/middleschool_extra_fields.csv)
 
-## The process: the Jupyter notebook
+## Composing the list
 
-Feel free to take a look at [the notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb)
+Feel free to take a look at [the Jupyter notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb) for a quick idea of the process (outdated version).
 
-### Requirements to run the notebook
+To actually compose the list, please run the shell and python scripts in the `list_scripts` directory in order.
+
+### Requirements
 
 Command line utilities:
 
@@ -35,10 +39,12 @@ Python modules:
 
 ## Streamlit web interface
 
-The app is deployed here: [middleschoolmtg.streamlit.app](https://middleschoolmtg.streamlit.app/)
+This repository also hosts a web app where users can search for Middle School legal cards or check the legality of cards in a list.
+
+The app is deployed here: [alecrem-middleschool.hf.space](https://alecrem-middleschool.hf.space/).
 
 To run the Streamlit app locally, install the [streamlit](https://docs.streamlit.io/library/get-started) module and run:
 
 ```sh
-streamlit run Middle_School_Card_List.py
+streamlit run Middle_School_Card_Search.py
 ```

list_scripts/1_download_mtgjson.sh

@@ -1,9 +1,11 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository):
+#
+# sh list_scripts/1_download_mtgjson.sh
+
 # Download mtgjson data and extract it on the `data` directory
 # Feel free to make the file available in any other way
 
-# Important: run this script from the parent directory
-# (the root directory in this repository)
-
 cd data
 wget "https://mtgjson.com/api/v5/AllPrintings.json.bz2"
 bunzip2 AllPrintings.json.bz2

list_scripts/2_per_set_json_files.py

@@ -1,7 +1,11 @@
-## Important: run this script from the parent directory
-## (the root directory in this repository)
+# Important: run this script from the parent directory
+# (the root directory in this repository)
 #
-# python3 list_scripts/1.py
+# python3 list_scripts/2_per_set_json_files.py
+#
+# Then, run the newly generated bash script:
+#
+# sh list_scripts/3_separate_json_files_per_set.sh
 
 # The Raw data is very large, so let's make JSON files for all relevant sets
 # Note: this can take a couple minutes to run

list_scripts/4_compile_from_legal_sets.py

@@ -1,3 +1,8 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository)
+#
+# python3 list_scripts/4_compile_from_legal_sets.py
+
 import json
 import pandas as pd
 

list_scripts/5_remove_wrong_names.py

@@ -1,3 +1,8 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository)
+#
+# python3 list_scripts/5_remove_wrong_names.py
+
 import pandas as pd
 
 # Remove Japanese card names that are wrong on MTGJSON

list_scripts/6_find_remaining_japanese_names.py

@@ -1,3 +1,8 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository)
+#
+# python3 list_scripts/6_find_remaining_japanese_names.py
+
 import pandas as pd
 import time
 from requests_html import HTMLSession

list_scripts/7_remove_banned_cards.py

@@ -1,3 +1,8 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository)
+#
+# python3 list_scripts/7_remove_banned_cards.py
+
 import pandas as pd
 
 # Remove cards that are banned in the format

list_scripts/8_add_other_fields.py

@@ -1,3 +1,8 @@
+# Important: run this script from the parent directory
+# (the root directory in this repository)
+#
+# python3 list_scripts/8_add_other_fields.py
+
 import json
 import pandas as pd