# Battle Cats Event Data Downloader
The Battle Cats Event Data Downloader (BCEDD) is a tool made for downloading battle cats event data such as gatya data and sale data.
[PyPI](https://pypi.org/project/bcedd)
## Credits
- The [PackPack Discord Bot](https://github.com/battlecatsultimate/PackPack) for the old method of downloading data (aws stuff)
## How To Use
### Prerequisites
- [Python](https://www.python.org/downloads/) for running and installing the tool
Run the following commands in command prompt or another terminal to install the tool - If you are not using windows you will need to use `python` or `python3` instead of `py`
### Installation
To install / update the tool run the following command:
```bash
py -m pip install -U bcedd
```
If you get an error saying `No module named pip` then run
```bash
py -m ensurepip --upgrade
```
### Run
By default the tool will download `sale.tsv`, `gatya.tsv` and `item.tsv` for `en` and it will ask you where you want to save it:
```bash
py -m bcedd
```
If you want to download files for different versions use `-c <version1> <version2> etc`. Supported versions are `en`, `jp`, `kr`, `tw`.
```bash
py -m bcedd -c jp kr
```
This will download jp and kr data instead
If you only want to download specific files then use `-f <file1> <file2> etc`. Supported files are `sale.tsv`, `gatya.tsv`, `item.tsv`.
```bash
py -m bcedd -f gatya.tsv item.tsv
```
This will download files `gatya.tsv` and `item.tsv` but not `sale.tsv`
If you don't want a file save dialog then use `-o <output_folder>` to save the files to a specific folder.
```bash
py -m bcedd -o "Event Data"
```
This will save all 3 en files to a folder called "Event Data" in the current working directory (use the `cd` command to change that)
If you want to use the old method of downloading data then use `--old`
```bash
py -m bcedd --old
```
## Install From Source
If you want the latest features and don't want to wait for a release then you can install the tool from the github directly.
1. Download [Git](https://git-scm.com/downloads)
2. Run the following commands: (You may have to replace `py` with `python` or `python3`)
```bash
git clone https://github.com/fieryhenry/bcedd.git
py -m pip install -e bcedd/
py -m bcedd
```
If you want to use the tool again all you need to do is run the `py -m bcedd` command
Then if you want the latest changes you only need to run `git pull` in the downloaded `bcedd` folder. (use `cd` to change the folder)
Raw data
{
"_id": null,
"home_page": "https://github.com/fieryhenry/bcedd",
"name": "bcedd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "fieryhenry",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/13/da/aed3e6f1450cfa916f70b1d21744af4f3014ecd3b7f5ff651a25cc2bbbac/bcedd-1.2.1.tar.gz",
"platform": null,
"description": "# Battle Cats Event Data Downloader\n\nThe Battle Cats Event Data Downloader (BCEDD) is a tool made for downloading battle cats event data such as gatya data and sale data.\n\n[PyPI](https://pypi.org/project/bcedd)\n\n## Credits\n\n- The [PackPack Discord Bot](https://github.com/battlecatsultimate/PackPack) for the old method of downloading data (aws stuff)\n\n## How To Use\n\n### Prerequisites\n\n- [Python](https://www.python.org/downloads/) for running and installing the tool\n\nRun the following commands in command prompt or another terminal to install the tool - If you are not using windows you will need to use `python` or `python3` instead of `py`\n\n### Installation\n\nTo install / update the tool run the following command:\n\n```bash\npy -m pip install -U bcedd\n```\n\nIf you get an error saying `No module named pip` then run\n\n```bash\npy -m ensurepip --upgrade\n```\n\n### Run\n\nBy default the tool will download `sale.tsv`, `gatya.tsv` and `item.tsv` for `en` and it will ask you where you want to save it:\n\n```bash\npy -m bcedd\n```\n\nIf you want to download files for different versions use `-c <version1> <version2> etc`. Supported versions are `en`, `jp`, `kr`, `tw`.\n\n```bash\npy -m bcedd -c jp kr\n```\n\nThis will download jp and kr data instead\n\nIf you only want to download specific files then use `-f <file1> <file2> etc`. Supported files are `sale.tsv`, `gatya.tsv`, `item.tsv`.\n\n```bash\npy -m bcedd -f gatya.tsv item.tsv\n```\n\nThis will download files `gatya.tsv` and `item.tsv` but not `sale.tsv`\n\nIf you don't want a file save dialog then use `-o <output_folder>` to save the files to a specific folder.\n\n```bash\npy -m bcedd -o \"Event Data\"\n```\n\nThis will save all 3 en files to a folder called \"Event Data\" in the current working directory (use the `cd` command to change that)\n\nIf you want to use the old method of downloading data then use `--old`\n\n```bash\npy -m bcedd --old\n```\n\n## Install From Source\n\nIf you want the latest features and don't want to wait for a release then you can install the tool from the github directly.\n\n1. Download [Git](https://git-scm.com/downloads)\n2. Run the following commands: (You may have to replace `py` with `python` or `python3`)\n\n```bash\ngit clone https://github.com/fieryhenry/bcedd.git\npy -m pip install -e bcedd/\npy -m bcedd\n```\n\nIf you want to use the tool again all you need to do is run the `py -m bcedd` command\n\nThen if you want the latest changes you only need to run `git pull` in the downloaded `bcedd` folder. (use `cd` to change the folder)\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/fieryhenry/bcedd"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21a0006b96e67896e11e20635367c51e674875d9e586521694aad7d525184c3e",
"md5": "d0c135dd85b36251b6b6429e0698c805",
"sha256": "7f92064dbdcad84f0f620ba82a7ef71bae581f89620ca7a87c1724c2a7764fbe"
},
"downloads": -1,
"filename": "bcedd-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0c135dd85b36251b6b6429e0698c805",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 11328,
"upload_time": "2024-07-14T15:17:04",
"upload_time_iso_8601": "2024-07-14T15:17:04.194225Z",
"url": "https://files.pythonhosted.org/packages/21/a0/006b96e67896e11e20635367c51e674875d9e586521694aad7d525184c3e/bcedd-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13daaed3e6f1450cfa916f70b1d21744af4f3014ecd3b7f5ff651a25cc2bbbac",
"md5": "3f9e7b3394fe5ab9c0240ef8cae60bd4",
"sha256": "71c95abfa7aad9877454a78303f1a6d1bbc3cc9de9f696dfbcdb217e38fde70a"
},
"downloads": -1,
"filename": "bcedd-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "3f9e7b3394fe5ab9c0240ef8cae60bd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10801,
"upload_time": "2024-07-14T15:17:05",
"upload_time_iso_8601": "2024-07-14T15:17:05.739976Z",
"url": "https://files.pythonhosted.org/packages/13/da/aed3e6f1450cfa916f70b1d21744af4f3014ecd3b7f5ff651a25cc2bbbac/bcedd-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-14 15:17:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fieryhenry",
"github_project": "bcedd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "bcedd"
}
JSON
