Skip to content

Commit

Permalink
only have v5
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeldaZach committed Mar 24, 2020
1 parent d36d5c4 commit eccc88b
Show file tree
Hide file tree
Showing 95 changed files with 78 additions and 6,893 deletions.
File renamed without changes.
86 changes: 78 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@

[![Changelog](https://img.shields.io/badge/dynamic/json.svg?label=Version&url=https%3A%2F%2Fmtgjson.com%2Fjson%2Fversion.json&query=%24.version&colorB=blue)](https://mtgjson.com/changelog/) [![Current Release Date](https://img.shields.io/badge/dynamic/json.svg?label=Released&url=https%3A%2F%2Fmtgjson.com%2Fjson%2Fversion.json&query=%24.date&colorB=blue)](https://mtgjson.com/changelog/)

MTGJSON is an open source database creation and distribution tool for [_Magic: The Gathering_](https://magic.wizards.com/) cards, and it supports data types such as [JSON](https://json.org/), [CSV](https://en.wikipedia.org/wiki/Comma-separated_values), [SQL](https://en.wikipedia.org/wiki/SQL), and [SQLite](https://www.sqlite.org/index.html).


## **Support Our Work**
MTGJSON relies on the community to keep

[![PayPal](https://img.shields.io/static/v1.svg?label=PayPal&message=Support%20MTGJSON&color=Blue&logo=paypal)](https://paypal.me/zachhalpern)

[![Patreon](https://img.shields.io/static/v1.svg?label=Patreon&message=Support%20MTGJSON&color=Orange&logo=patreon)](https://patreon.com/mtgjson)

MTGJSON is an open sourced database creation and distribution tool for [_Magic: The Gathering_](https://magic.wizards.com/) cards, specifically in [JSON](https://json.org/) format.
 

## **Connect With Us**
## **Contribute**
MTGJSON is a freely available, open source service, and we rely on you to help us keep it that way. We gratefully accept community donations through Patreon or Paypal, and we welcome new code contribution.

Want to help

## **Connect With Us**

[![Discord](https://img.shields.io/discord/224178957103136779?label=Discord&logo=discord&logoColor=white&style=for-the-badge)](https://mtgjson.com/discord)
___
Expand All @@ -31,3 +29,75 @@ To provide feedback :information_desk_person: and/or bug reports :bug:, please [
If you would like to join or assist the development of the project, you can [join us on Discord](https://discord.gg/Hgyg7GJ) to discuss things further.

Looking for a full digest of pre-built data? Click [here](#notes).

 
___

## **Dependencies**

- `Python 3.7`
- Can be installed with at the official [Python Website](https://www.python.org/downloads/) or using [Homebrew](https://brew.sh/).
- `pip3`
- Installed with `Python 3.7`. For troubleshooting check [here](https://stackoverflow.com/search?q=how+to+install+pip3).

 
___

## **Installation**

Install the MTGJSON4 package and dependencies via:

```sh
pip3 install -r requirements.txt
```

 
___

## **Output Flags**

| Flags | Flag Descriptions |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `-h, --help` | Print the help menu and exits. |
| `-a` | Build all sets. This overshadows the `-s` flag. |
| `-c` | After building any/all sets, create the compiled outputs (ex: AllSets, AllCards). |
| `-x` | Skips sets that have already been built (i.e. set files in the output folder), and build the remaining sets. Must be passed with `-a` or `-s`. |
| `-z` | Compress the outputs directory contents |
| `-s SET [SET ...]` | Build set code arguments, provided they exist. |
| `--skip-keys` | If you don't have all required API keys (TCGPlayer & MKM), you can disable the building of these components. |
| `--skip-sets SET [SET ...]` | Prevents set code arguments from being built, even if passed in via `-a` or `-s`. |
| `--skip-cache` | Disables the reading and writing of cached content |
| `--pretty-output` | Indent the output files for easier human readability |

>  
> **Newcomer Note**: Omitting either the `-a` and `-s` flag will yield empty outputted data.
>  
 
___

## **Running**

Run the program, with any flag(s) you'd like, via:

```sh
python3 -m mtgjson4 [-h] [-a] [-c] [-x] [-z] [-s [SET [SET ...]]] [--skip-keys]
[--skip-sets [SET [SET ...]]] [--skip-cache] [--pretty-output]

```
Example:
```sh
$ python3 -m mtgjson4 -acz

> all outputted json files, then compress them
```
___
## **Notes**
>  
> These are the build directions to compile your own JSON files but If you are looking for pre-compiled JSON files, you can download them at [MTGJSON.com](https://mtgjson.com/).
>  
127 changes: 0 additions & 127 deletions mtgjson4/.gitignore

This file was deleted.

72 changes: 0 additions & 72 deletions mtgjson4/.pylintrc

This file was deleted.

Loading

0 comments on commit eccc88b

Please sign in to comment.