# DUEL COMMANDER BANLIST
A new service to help developpers to keep an up-to-date MTGDC data.
## THE SOLUTION TO KEEP THE PROJECT UPDATED
* Each banlist is stored as `JSON` file of condensed data from official source (in `mtgdc_banlist/banlists` folder)
* Static files generated by running a script (`python mtgdc_banlist`) which uses banlists files to create the main part of the document, and adds html header/footer from static files (`static/banlist_html_header.html` and `static/banlist_html_footer.html`)
### BANLIST FILE FORMAT
File name must be `%Y-%m-%d.json` format with the following template:
```json
[
{
"date": "2015-01-31",
"special": "",
"newly_banned_as_commander": [],
"newly_unbanned_as_commander": [],
"newly_banned_in_deck": [],
"newly_unbanned_in_deck": [],
"explanations": {}
}
]
```
### HOW TO ADD NEW BANLIST
1. Put banlist file `%Y-%m-%d.json` file into `./banlists`
1. Re-run python `python mtgdc_banlist` with options `--compile-html`, `--compile-json` or `--compile-both`
*Works similar to edit/delete a banlist.*
## REQUIREMENTS
* Python (v3.10+)
## INSTALLATION
```bash
python3 -m venv venv
source venv/bin/activate
pip install mtgdc_banlist
python mtgdc_banlist --compile-both
```
## EXAMPLE
Hosted examples of generated static html from the repo:
* [Barrin's Codex](https://banlist-beta.barrins-codex.org)
Raw data
{
"_id": null,
"home_page": "https://github.com/barrins-codex/mtgdc-banlist",
"name": "mtgdc-banlist",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "magic mtg duel-commadner dc",
"author": "barrins-codex",
"author_email": "spigushe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/90/d8/99ce3c93654205e6fee3437592993315b2c0229539f6a774eefcc53781ed/mtgdc_banlist-1.2.tar.gz",
"platform": null,
"description": "# DUEL COMMANDER BANLIST\nA new service to help developpers to keep an up-to-date MTGDC data.\n\n## THE SOLUTION TO KEEP THE PROJECT UPDATED\n* Each banlist is stored as `JSON` file of condensed data from official source (in `mtgdc_banlist/banlists` folder)\n* Static files generated by running a script (`python mtgdc_banlist`) which uses banlists files to create the main part of the document, and adds html header/footer from static files (`static/banlist_html_header.html` and `static/banlist_html_footer.html`)\n\n### BANLIST FILE FORMAT\nFile name must be `%Y-%m-%d.json` format with the following template:\n```json\n[\n {\n \"date\": \"2015-01-31\",\n \"special\": \"\",\n \"newly_banned_as_commander\": [],\n \"newly_unbanned_as_commander\": [],\n \"newly_banned_in_deck\": [],\n \"newly_unbanned_in_deck\": [],\n \"explanations\": {}\n }\n]\n```\n\n### HOW TO ADD NEW BANLIST\n1. Put banlist file `%Y-%m-%d.json` file into `./banlists`\n1. Re-run python `python mtgdc_banlist` with options `--compile-html`, `--compile-json` or `--compile-both`\n\n*Works similar to edit/delete a banlist.*\n\n## REQUIREMENTS\n* Python (v3.10+)\n\n## INSTALLATION\n```bash\npython3 -m venv venv\nsource venv/bin/activate\npip install mtgdc_banlist\n\npython mtgdc_banlist --compile-both\n```\n\n## EXAMPLE\nHosted examples of generated static html from the repo:\n* [Barrin's Codex](https://banlist-beta.barrins-codex.org)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI, new way to help keep an up-to-date MTGDC banlist",
"version": "1.2",
"project_urls": {
"Homepage": "https://github.com/barrins-codex/mtgdc-banlist"
},
"split_keywords": [
"magic",
"mtg",
"duel-commadner",
"dc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0797153a7e68320d222d9a0708ecafceb34c33de9008b2013d101280cf0c57a",
"md5": "3a08e9378b8559b80336baef3ebb6179",
"sha256": "c2797d202e1ae764953793db00ece649b7f0a3abde8f2580ae00e84ddd81b8f6"
},
"downloads": -1,
"filename": "mtgdc_banlist-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a08e9378b8559b80336baef3ebb6179",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 66048,
"upload_time": "2023-08-12T13:13:37",
"upload_time_iso_8601": "2023-08-12T13:13:37.855496Z",
"url": "https://files.pythonhosted.org/packages/d0/79/7153a7e68320d222d9a0708ecafceb34c33de9008b2013d101280cf0c57a/mtgdc_banlist-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90d899ce3c93654205e6fee3437592993315b2c0229539f6a774eefcc53781ed",
"md5": "c19ab38c46685527c5df91f57d6398f3",
"sha256": "abbfd5f62368e93952a97d017d1ec75a8ca702b25e545429fb7b982b60dfc63d"
},
"downloads": -1,
"filename": "mtgdc_banlist-1.2.tar.gz",
"has_sig": false,
"md5_digest": "c19ab38c46685527c5df91f57d6398f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 84494,
"upload_time": "2023-08-12T13:13:40",
"upload_time_iso_8601": "2023-08-12T13:13:40.493316Z",
"url": "https://files.pythonhosted.org/packages/90/d8/99ce3c93654205e6fee3437592993315b2c0229539f6a774eefcc53781ed/mtgdc_banlist-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-12 13:13:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barrins-codex",
"github_project": "mtgdc-banlist",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "black",
"specs": []
},
{
"name": "isort",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "pylint",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx-rtd-theme",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "unidecode",
"specs": []
}
],
"lcname": "mtgdc-banlist"
}
JSON
