Skip to main content

Killboard Stats shows Hall of Shame/Fame, Kills, Top Kills,Loss,etc.

Project description

Killstats module for AllianceAuth.

pre-commit.ci status Code style: black Tests codecov

ko-fi

Killstats for Corporations & Alliances, Hall of Fame, Hall of Shame, etc.

-

Features

  • Graphical Overview
  • Corporation & Alliance Overview
  • Kills from alts count to Main Character
  • Hall of Fame, Hall of Shame
  • Killstats like Top Kill, Top Killer, Top Loss, Alltime Killer, etc.
  • Kills/Losses

Upcoming

  • Filtering Settings for each Corporation / Alliance
  • Administration Access for specific Corps or Alliances

Installation

[!NOTE] AA Killstats needs at least Alliance Auth v4.0.0 Please make sure to update your Alliance Auth before you install this APP

Step 0 - Check dependencies are installed

Step 1 - Install the Package

Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.

pip install aa-killstats

Step 2 - Configure Alliance Auth

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

  • Add 'killstats', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

To set up the Scheduled Tasks add following code to your local.py

CELERYBEAT_SCHEDULE["killstats_killmail_fetch"] = {
    "task": "killstats.tasks.killmail_fetch_all",
    "schedule": crontab(minute=0, hour="*/1"),
}

Step 4 - Migration to AA

python manage.py collectstatic
python manage.py migrate

Step 5 - Setting up Permissions

With the Following IDs you can set up the permissions for the KILLSTATS

ID Description
basic_access Can access this app, Killstats. All Members with the Permission can access the Killstats App.
admin_access Has access to all killstats. Has access to all Killstats Views, Can add Corporation/Alliance.

Step 6 - (Optional) Setting up Compatibilies

The Following Settings can be setting up in the local.py

  • KILLSTATS_APP_NAME: "YOURNAME" - Set the name of the APP

  • KILLSTATS_LOGGER_USE: True / False - Set to use own Logger File

If you set up KILLSTATS_LOGGER_USE to True you need to add the following code below:

LOGGING_KILLSTATS = {
    "handlers": {
        "killstats_file": {
            "level": "INFO",
            "class": "logging.handlers.RotatingFileHandler",
            "filename": os.path.join(BASE_DIR, "log/killstats.log"),
            "formatter": "verbose",
            "maxBytes": 1024 * 1024 * 5,
            "backupCount": 5,
        },
    },
    "loggers": {
        "killstats": {
            "handlers": ["killstats_file", "console"],
            "level": "INFO",
        },
    },
}
LOGGING["handlers"].update(LOGGING_KILLSTATS["handlers"])
LOGGING["loggers"].update(LOGGING_KILLSTATS["loggers"])

Highlights

Screenshot 2024-06-26 144010

[!NOTE] Contributing You want to improve the project? Just Make a Pull Request with the Guidelines. We Using pre-commit

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_killstats-0.5.0a1.tar.gz (122.5 kB view details)

Uploaded Source

Built Distribution

aa_killstats-0.5.0a1-py3-none-any.whl (152.9 kB view details)

Uploaded Python 3

File details

Details for the file aa_killstats-0.5.0a1.tar.gz.

File metadata

  • Download URL: aa_killstats-0.5.0a1.tar.gz
  • Upload date:
  • Size: 122.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for aa_killstats-0.5.0a1.tar.gz
Algorithm Hash digest
SHA256 6293a2e6d5b352c7363db3374f84795d3422c729ec0cb7691101df3fcf70c1b8
MD5 392214aaa28b45ad034d4ecee1f4f6d3
BLAKE2b-256 8f94c307cef28b94aa7d2fdac9fb71569474206cf4385f96ae43fc0e9b729263

See more details on using hashes here.

File details

Details for the file aa_killstats-0.5.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for aa_killstats-0.5.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a593e22107167c40ba57cedc73e45539bf5943801668c2d552db95d10f66bbd
MD5 a407026f463c017c640971ac4de42cfd
BLAKE2b-256 646b126f6406412c5299d50ef3ec2d41bd7777daf0501f8296aed8f51763249f

See more details on using hashes here.

Supported by

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