Spaces:
Running
Running
Alejandro Cremades
commited on
Commit
•
57a2c7b
1
Parent(s):
fc00695
Update README.md
Browse files
README.md
CHANGED
@@ -6,20 +6,24 @@ app_file: "Middle_School_Card_Search.py"
|
|
6 |
|
7 |
# middleschool-cardlist
|
8 |
|
9 |
-
Composes a list of Magic cards legal in the Middle School format
|
10 |
|
11 |
## List of Middle School legal cards
|
12 |
|
13 |
You can download the list in the following formats:
|
14 |
|
15 |
-
- [JSON](output/middleschool.json)
|
16 |
-
- [CSV](output/middleschool.csv)
|
|
|
|
|
17 |
|
18 |
-
##
|
19 |
|
20 |
-
Feel free to take a look at [the notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb)
|
21 |
|
22 |
-
|
|
|
|
|
23 |
|
24 |
Command line utilities:
|
25 |
|
@@ -35,10 +39,12 @@ Python modules:
|
|
35 |
|
36 |
## Streamlit web interface
|
37 |
|
38 |
-
|
|
|
|
|
39 |
|
40 |
To run the Streamlit app locally, install the [streamlit](https://docs.streamlit.io/library/get-started) module and run:
|
41 |
|
42 |
```sh
|
43 |
-
streamlit run
|
44 |
```
|
|
|
6 |
|
7 |
# middleschool-cardlist
|
8 |
|
9 |
+
Composes a list of Magic cards legal in the Middle School format.
|
10 |
|
11 |
## List of Middle School legal cards
|
12 |
|
13 |
You can download the list in the following formats:
|
14 |
|
15 |
+
- [JSON (Oracle IDs and card names only)](output/middleschool.json)
|
16 |
+
- [CSV (Oracle IDs and card names only)](output/middleschool.csv)
|
17 |
+
- [JSON (with additional columns)](output/middleschool_extra_fields.json)
|
18 |
+
- [CSV (with additional columns)](output/middleschool_extra_fields.csv)
|
19 |
|
20 |
+
## Composing the list
|
21 |
|
22 |
+
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).
|
23 |
|
24 |
+
To actually compose the list, please run the shell and python scripts in the `list_scripts` directory in order.
|
25 |
+
|
26 |
+
### Requirements
|
27 |
|
28 |
Command line utilities:
|
29 |
|
|
|
39 |
|
40 |
## Streamlit web interface
|
41 |
|
42 |
+
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.
|
43 |
+
|
44 |
+
The app is deployed here: [alecrem-middleschool.hf.space](https://alecrem-middleschool.hf.space/).
|
45 |
|
46 |
To run the Streamlit app locally, install the [streamlit](https://docs.streamlit.io/library/get-started) module and run:
|
47 |
|
48 |
```sh
|
49 |
+
streamlit run Middle_School_Card_Search.py
|
50 |
```
|