Skip to main content

Example plugin app for Alliance Auth.

Project description

AA eve-scout

AA module that adds commands to the allianceauth-discordbot related to the eve-scout API.
EVE-Scout API documentation can be found here.

Shoutout to Sky Diamond for the API and EVE-Scout for the tireless scanning.

release python django license

Features

  • Automated pings when a connection open in system close to a pre-defined system
  • Find connections close to a specific system
  • Find drifter observatories close to a specific system

Screenshots

example_ping.png

example_closest.png

example_drifters.png

Installations

Step 1 - Check prerequisites

  1. aa-evescout is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)

  2. aa-evescout requires two Alliance Auth modules to function. Make sure it is properly setup before going on.

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-evescout

Step 3 - Configure Auth settings

Configure your Auth settings (local.py) as follows:

  • Add 'evescout' to INSTALLED_APPS
  • Add below lines to your settings file:
CELERYBEAT_SCHEDULE['evescout_update_signatures'] = {
    'task': 'evescout.tasks.update_all_signatures',
    'schedule': crontab(minute='*/6'),
}

Step 4 - Finalize App installation

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic --noinput

Restart your supervisor services for Auth.

Step 5 - (OPTIONAL) Load eveuniverse data

This command isn't mandatory

If you want to speed up the application in the future you can decide to run

python manage.py eveuniverse_load_data map

This command will take some time to complete and consume a lot of database space. It isn't mandatory to run it so don't hesitate to skip it if you want to save database space.

Permissions

Permissions overview.

Name Description
create_pinger The user can use the /evescout initiate-pinger command in the alliance discord

Commands

The following commands can be used when running the module:

Name Description
evescout_update_signatures Updates all signatures from the EVE-scout API
evescout_load_system Manually loads a solar system to the database to use it in pingers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_evescout-1.1.0.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_evescout-1.1.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file aa_evescout-1.1.0.tar.gz.

File metadata

  • Download URL: aa_evescout-1.1.0.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for aa_evescout-1.1.0.tar.gz
Algorithm Hash digest
SHA256 988b0668dad94c498982968913dae4dd33b4381227bc078f89e4666d0c3a5a85
MD5 5c4f882ac6ce6bc391ddc919f907e225
BLAKE2b-256 79a3712abfd694a962ae959a782d8db17158887e5e0f042038b7daa554552c05

See more details on using hashes here.

File details

Details for the file aa_evescout-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: aa_evescout-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for aa_evescout-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7dcf5396cb6b3db6eb1728d942a72140e24418352388fe704b11a6562de85632
MD5 25f1c808f1c4973f3b9b26ce7f05eecf
BLAKE2b-256 b02408abe2e75e419d718a9d76ed8175591f5881ab695b977f07b0230fbba523

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page