# GCoCF (Clash of Clans War Monitor)
[](https://app.deepsource.com/gh/GILLESMaster/GCoCF/?ref=repository-badge)
GCoCF is a Discord service that monitors Clash of Clans wars and sends updates to a Discord server through webhooks.
## Installation
First clone and enter the repository, run the following commands:
```bash
git clone https://github.com/GILLESMaster/GCoCF
cd GCoCF/
```
To install the package and its dependencies, run the following commands:
```bash
pip install flit
pip3 install flit
flit install --extras=all
```
To install the dependencies for the Bot service, run the following commands:
```bash
cd GCoCF_Bot/
pip install -r requirements.txt
pip3 install -r requirements.txt
```
To install the dependencies for the API service, run the following commands:
```bash
cd GCoCF_API/
pip install -r requirements.txt
pip3 install -r requirements.txt
```
To update the package and its dependencies, run the following commands:
```bash
git pull
flit install --extras=all
```
To install the package and its dependencies from PyPI, run the following command:
```bash
pip isntall GCoCF
```
or
```bash
pip3 install GCoCF
```
## Running the Bot
After installing, you can run the bot by using the following command:
```bash
GCoCF --coc-token {token_here} --clan-tag {tag_here} --webhook-url {url_here}
```
### Extra Options
- ```--mute-attacks```: Mutes notification for attacks
- ```--warlog```: Path to warlog.db
- ```--loglevel```: Sets the logging level
- ```--dryrun```: Runs the bot without sending notifications or saving data
## Running Tests
You can run the test cases by using the following command:
Webhook program:
```bash
pytest test_everything.py -v --capture=no
```
Bot service program:
```bash
cd GCoCF_Bot/
pytest test_everything.py -v --capture=no
```
API service program:
```bash
cd GCoCF_API/
pytest test_everything.py -v --capture=no
```
Raw data
{
"_id": null,
"home_page": "https://github.com/GILLESMaster/GCoCF",
"name": "GCoCF",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "coc clashofclans discord",
"author": "Gustavo Schip",
"author_email": "gustavoschip@proton.me",
"download_url": "https://files.pythonhosted.org/packages/97/08/9249bfb8d04570593d5fa428af201f0373ef31e5c33d0fcb6409815419f3/gcocf-0.10.3.tar.gz",
"platform": null,
"description": "# GCoCF (Clash of Clans War Monitor)\n\n\n[](https://app.deepsource.com/gh/GILLESMaster/GCoCF/?ref=repository-badge)\n\nGCoCF is a Discord service that monitors Clash of Clans wars and sends updates to a Discord server through webhooks.\n\n## Installation\n\nFirst clone and enter the repository, run the following commands:\n\n```bash\ngit clone https://github.com/GILLESMaster/GCoCF\ncd GCoCF/\n```\n\nTo install the package and its dependencies, run the following commands:\n\n```bash\npip install flit\npip3 install flit\nflit install --extras=all\n```\n\nTo install the dependencies for the Bot service, run the following commands:\n\n```bash\ncd GCoCF_Bot/\npip install -r requirements.txt\npip3 install -r requirements.txt\n```\n\nTo install the dependencies for the API service, run the following commands:\n\n```bash\ncd GCoCF_API/\npip install -r requirements.txt\npip3 install -r requirements.txt\n```\n\nTo update the package and its dependencies, run the following commands:\n\n```bash\ngit pull\nflit install --extras=all\n```\n\nTo install the package and its dependencies from PyPI, run the following command:\n\n```bash\npip isntall GCoCF\n```\nor\n```bash\npip3 install GCoCF\n```\n\n## Running the Bot\n\nAfter installing, you can run the bot by using the following command:\n\n```bash\nGCoCF --coc-token {token_here} --clan-tag {tag_here} --webhook-url {url_here}\n```\n\n### Extra Options\n\n- ```--mute-attacks```: Mutes notification for attacks\n- ```--warlog```: Path to warlog.db\n- ```--loglevel```: Sets the logging level\n- ```--dryrun```: Runs the bot without sending notifications or saving data\n\n## Running Tests\n\nYou can run the test cases by using the following command:\n\nWebhook program:\n\n```bash\npytest test_everything.py -v --capture=no\n```\n\nBot service program:\n\n```bash\ncd GCoCF_Bot/\npytest test_everything.py -v --capture=no\n```\n\nAPI service program:\n\n```bash\ncd GCoCF_API/\npytest test_everything.py -v --capture=no\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Clash of Clans war moniting for Discord.",
"version": "0.10.3",
"project_urls": {
"Homepage": "https://github.com/GILLESMaster/GCoCF"
},
"split_keywords": [
"coc",
"clashofclans",
"discord"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a50c67819fc7c8a9448568917aad07cd844c607cb2437ad455d1ec6f0327aa19",
"md5": "edba681aedcd968cc430dfeb13787d0e",
"sha256": "dc638d36ca4f8e4946c2cf7d73bc45efea00df9999efea1b322c3ab41647b5dc"
},
"downloads": -1,
"filename": "gcocf-0.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edba681aedcd968cc430dfeb13787d0e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14986,
"upload_time": "2023-06-19T18:52:53",
"upload_time_iso_8601": "2023-06-19T18:52:53.981666Z",
"url": "https://files.pythonhosted.org/packages/a5/0c/67819fc7c8a9448568917aad07cd844c607cb2437ad455d1ec6f0327aa19/gcocf-0.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97089249bfb8d04570593d5fa428af201f0373ef31e5c33d0fcb6409815419f3",
"md5": "8353999081c435480736ca6fd63bc9a1",
"sha256": "60ff906d5a787715bd8dcd1744f8eec8a3bd4482525aedb24c1977029b666691"
},
"downloads": -1,
"filename": "gcocf-0.10.3.tar.gz",
"has_sig": false,
"md5_digest": "8353999081c435480736ca6fd63bc9a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 45905,
"upload_time": "2023-06-19T18:52:56",
"upload_time_iso_8601": "2023-06-19T18:52:56.081894Z",
"url": "https://files.pythonhosted.org/packages/97/08/9249bfb8d04570593d5fa428af201f0373ef31e5c33d0fcb6409815419f3/gcocf-0.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 18:52:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GILLESMaster",
"github_project": "GCoCF",
"github_not_found": true,
"lcname": "gcocf"
}
JSON
