| Name | allianceauth-corptools-pinger JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Leverage the corptools data to notify via discord certain events at a corp/alliance level |
| upload_time | 2025-02-05 13:00:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
allianceauth
eveonline
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# High Performance Pings
Leverage the corptools data to notify via discord certain events at a corp/alliance level
filter on/off regions/const/system/corps/alliances/types/strucutre type/notification type via admin. end specific notifications to different places via webhooks
configurable @ settings
# What Pings are Available
## Structures
- Attack/Reinforce
- StructureLostShields
- StructureLostArmor
- StructureUnderAttack
- low fuel ()
- abandoned ()
- destroyed (StructureDestroyed)
- low power (StructureWentLowPower)
- anchoring (StructureAnchoring)
- unanchoring (StructureUnanchoring)
- high power (StructureWentHighPower)
- transfer (OwnershipTransferred)
## POS
- Attack/Reinforce
- TowerAlertMsg
## Sov
- Attacks
- SovStructureReinforced
- EntosisCaptureStarted
- POS Anchoring (AllAnchoringMsg) - Currently disabled by CCP
## Moons
- Extraction Started (MoonminingExtractionStarted)
- Extraction Complete (MoonminingExtractionFinished)
- Laser Fired (MoonminingLaserFired)
- Auto Fracture (MoonminingAutomaticFracture)
## HR
- New Application (CorpAppNewMsg)
## Corporation Projects
- Started (CorporationGoalCreated)
- Closed (CorporationGoalClosed)
- Completed (CorporationGoalCompleted)
- Expired (CorporationGoalExpired)
- Limit Reached (CorporationGoalLimitReached)
# Installation
1. This app requires Corp-Tools to leverage Notification Data, install this first.
- Assumptions made:
- All characters that can provide notifications for the pings are loaded into the Character Audit module with at least notifications and roles modules enabled
- All corporations that need to be monitored for fuel have a structures token loaded in the Corporation Audit Module.
- All corporations that need to get fuel/lo/gas notifications have an assets token loaded in the Corporation Audit Module.
1. `pip install allianceauth-corptools-pinger`
1. Add `'pinger',` to your `INSTALLED_APPS` in your projects `local.py`
1. Migrate, Collectstatic, Restart Auth.
1. Configure Pinger at `/admin/pinger/pingerconfig/1/change/`
1. Verify pinger is setup with `python manage.py pinger_stats`
# Setup
add periodic task, default timing below.
`pinger.tasks.bootstrap_notification_tasks`
make a new cron `*/10 * * * * *`
# Optional Optimization
This is only required if you have issues with backlog on your main workers. Generally not an issue for smaller installations.
## Separate Worker Queue
Edit `myauth/myauth/celery.py`
```python
app.conf.task_routes = {.....
'pinger.tasks.corporation_notification_update': {'queue':'pingbot'},
.....
}
```
## Bare Metal
Add program block to `supervisor.conf`
```ini
[program:pingbot]
command=/path/to/venv/venv/bin/celery -A myauth worker --pool=threads --concurrency=5 -Q pingbot
directory=/home/allianceserver/myauth
user=allianceserver
numprocs=1
stdout_logfile=/home/allianceserver/myauth/log/pingbot.log
stderr_logfile=/home/allianceserver/myauth/log/pingbot.log
autostart=true
autorestart=true
startsecs=10
stopwaitsecs=60
killasgroup=true
priority=998
```
## Docker
add a new worker container
```compose
allianceauth_worker_pingbot:
container_name: allianceauth_worker_pingbot
<<: [*allianceauth-base, *allianceauth-health-checks]
entrypoint: ["celery","-A","myauth","worker","--pool=threads","--concurrency=10","-Q","pingbot","-n","P_%n"]
```
## Settings
| Name | Description | Default |
| ------------------------ | ------------------------------------------------------------- | ---------- |
| `CT_PINGER_VALID_STATES` | A List of Valid States to be queries for Pinger notifications | ["Member"] |
Raw data
{
"_id": null,
"home_page": null,
"name": "allianceauth-corptools-pinger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "allianceauth, eveonline",
"author": null,
"author_email": "AaronKable <aaronkable@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/25/e4/c76d48512ad8e02d992807016f0a7fcf9f968228f4ac4648964e1d59359a/allianceauth_corptools_pinger-0.6.0.tar.gz",
"platform": null,
"description": "# High Performance Pings\n\nLeverage the corptools data to notify via discord certain events at a corp/alliance level\n\nfilter on/off regions/const/system/corps/alliances/types/strucutre type/notification type via admin. end specific notifications to different places via webhooks\n\nconfigurable @ settings\n\n# What Pings are Available\n\n## Structures\n\n- Attack/Reinforce\n - StructureLostShields\n - StructureLostArmor\n - StructureUnderAttack\n- low fuel ()\n- abandoned ()\n- destroyed (StructureDestroyed)\n- low power (StructureWentLowPower)\n- anchoring (StructureAnchoring)\n- unanchoring (StructureUnanchoring)\n- high power (StructureWentHighPower)\n- transfer (OwnershipTransferred)\n\n## POS\n\n- Attack/Reinforce\n - TowerAlertMsg\n\n## Sov\n\n- Attacks\n - SovStructureReinforced\n - EntosisCaptureStarted\n- POS Anchoring (AllAnchoringMsg) - Currently disabled by CCP\n\n## Moons\n\n- Extraction Started (MoonminingExtractionStarted)\n- Extraction Complete (MoonminingExtractionFinished)\n- Laser Fired (MoonminingLaserFired)\n- Auto Fracture (MoonminingAutomaticFracture)\n\n## HR\n\n- New Application (CorpAppNewMsg)\n\n## Corporation Projects\n\n- Started (CorporationGoalCreated)\n- Closed (CorporationGoalClosed)\n- Completed (CorporationGoalCompleted)\n- Expired (CorporationGoalExpired)\n- Limit Reached (CorporationGoalLimitReached)\n\n# Installation\n\n1. This app requires Corp-Tools to leverage Notification Data, install this first.\n\n- Assumptions made:\n - All characters that can provide notifications for the pings are loaded into the Character Audit module with at least notifications and roles modules enabled\n - All corporations that need to be monitored for fuel have a structures token loaded in the Corporation Audit Module.\n - All corporations that need to get fuel/lo/gas notifications have an assets token loaded in the Corporation Audit Module.\n\n1. `pip install allianceauth-corptools-pinger`\n1. Add `'pinger',` to your `INSTALLED_APPS` in your projects `local.py`\n1. Migrate, Collectstatic, Restart Auth.\n1. Configure Pinger at `/admin/pinger/pingerconfig/1/change/`\n1. Verify pinger is setup with `python manage.py pinger_stats`\n\n# Setup\n\nadd periodic task, default timing below.\n\n`pinger.tasks.bootstrap_notification_tasks`\n\nmake a new cron `*/10 * * * * *`\n\n# Optional Optimization\n\nThis is only required if you have issues with backlog on your main workers. Generally not an issue for smaller installations.\n\n## Separate Worker Queue\n\nEdit `myauth/myauth/celery.py`\n\n```python\napp.conf.task_routes = {.....\n 'pinger.tasks.corporation_notification_update': {'queue':'pingbot'},\n .....\n }\n```\n\n## Bare Metal\n\nAdd program block to `supervisor.conf`\n\n```ini\n[program:pingbot]\ncommand=/path/to/venv/venv/bin/celery -A myauth worker --pool=threads --concurrency=5 -Q pingbot\ndirectory=/home/allianceserver/myauth\nuser=allianceserver\nnumprocs=1\nstdout_logfile=/home/allianceserver/myauth/log/pingbot.log\nstderr_logfile=/home/allianceserver/myauth/log/pingbot.log\nautostart=true\nautorestart=true\nstartsecs=10\nstopwaitsecs=60\nkillasgroup=true\npriority=998\n```\n\n## Docker\n\nadd a new worker container\n\n```compose\n allianceauth_worker_pingbot:\n container_name: allianceauth_worker_pingbot\n <<: [*allianceauth-base, *allianceauth-health-checks]\n entrypoint: [\"celery\",\"-A\",\"myauth\",\"worker\",\"--pool=threads\",\"--concurrency=10\",\"-Q\",\"pingbot\",\"-n\",\"P_%n\"]\n```\n\n## Settings\n\n| Name | Description | Default |\n| ------------------------ | ------------------------------------------------------------- | ---------- |\n| `CT_PINGER_VALID_STATES` | A List of Valid States to be queries for Pinger notifications | [\"Member\"] |\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Leverage the corptools data to notify via discord certain events at a corp/alliance level",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-corp-tools-pinger",
"Source": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-corp-tools-pinger",
"Tracker": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-corp-tools-pinger/issues"
},
"split_keywords": [
"allianceauth",
" eveonline"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7910562f9fcf66c78a278523614a5838a9b2b3fc647aa43681379d7cd3bdc115",
"md5": "57e0bbed7591f99ef1ae20e6a3cce1bf",
"sha256": "035435762dd398ac984827b63a5a9068cd3ce2848f9e43a36e92a9186afc8c33"
},
"downloads": -1,
"filename": "allianceauth_corptools_pinger-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57e0bbed7591f99ef1ae20e6a3cce1bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53369,
"upload_time": "2025-02-05T13:00:44",
"upload_time_iso_8601": "2025-02-05T13:00:44.267792Z",
"url": "https://files.pythonhosted.org/packages/79/10/562f9fcf66c78a278523614a5838a9b2b3fc647aa43681379d7cd3bdc115/allianceauth_corptools_pinger-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "25e4c76d48512ad8e02d992807016f0a7fcf9f968228f4ac4648964e1d59359a",
"md5": "ee347326a9d0eb57f9b946c91326b018",
"sha256": "dd25aa53d5bc2a3f1d3daa24d005bff8cbae4a898ddd684cd496a4fd689be208"
},
"downloads": -1,
"filename": "allianceauth_corptools_pinger-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "ee347326a9d0eb57f9b946c91326b018",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 40328,
"upload_time": "2025-02-05T13:00:45",
"upload_time_iso_8601": "2025-02-05T13:00:45.439596Z",
"url": "https://files.pythonhosted.org/packages/25/e4/c76d48512ad8e02d992807016f0a7fcf9f968228f4ac4648964e1d59359a/allianceauth_corptools_pinger-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 13:00:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Solar-Helix-Independent-Transport",
"github_project": "allianceauth-corp-tools-pinger",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "allianceauth-corptools-pinger"
}
