Skip to main content

A Skillfarm Tracker Module for Alliance Auth

Project description

Skillfarm module for AllianceAuth.

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

ko-fi

The Skillfarm Tracker Module for Alliance Auth tracks skill queues, sends notifications if skills finished and highlights them, making skill management easier for Skillfarms.


Features

  • Graphical Design
  • Characters Overview
  • Skillfarm Information Sheet
    • Filtered Skill Queue
    • Filtered Skills
    • Highlight finished Skills
  • Filter Skills for each Character
  • No Active Training hint

Upcoming

  • Notififcation System

Installation

[!NOTE] AA Skillfarm 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

  • Skillfarm needs the app django-eveuniverse to function. Please make sure it is 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-skillfarm

Step 2 - Configure Alliance Auth

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

  • Add 'skillfarm', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

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

CELERYBEAT_SCHEDULE["skillfarm_update_all_skillfarm"] = {
    "task": "skillfarm.tasks.update_all_skillfarm",
    "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 Skillfarm

ID Description
basic_access Can access the Skillfarm module All Members with the Permission can access the Skillfarm.
corp_access Has access to all characters in the corporation. Can see all Skillfarm Characters from own Corporation.
admin_access Has access to all characters Can see all Skillfarm Characters.

Step 6 - (Optional) Setting up Compatibilies

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

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

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

  • SKILLFARM_STALE_STATUS: 3 - Set the Stale Status for Skillfarm Character in hours

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

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

Highlights

skillfarm1 Screenshot 2024-09-21 012008

[!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_skillfarm-0.3.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

aa_skillfarm-0.3.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file aa_skillfarm-0.3.0.tar.gz.

File metadata

  • Download URL: aa_skillfarm-0.3.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for aa_skillfarm-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e37bd8c8ed3cd933ada7622fa078269fff5b993d30f938d8e6e425f986dc7457
MD5 6521b64b26c120ea05b262d11da7b24c
BLAKE2b-256 f10cef2e1ca4fe2dc325fdbddacfeeda5576acf268e0d1ae2ab1b0a01eb18378

See more details on using hashes here.

File details

Details for the file aa_skillfarm-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aa_skillfarm-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 819fa0851a2e78d122808c1ccf7e1761524ba2dcd02e535f886f6e9067ee880c
MD5 196c25f9dad9835dc8af8851bd1435d8
BLAKE2b-256 1b0c72813568d94d7442fcf666ba6e442fb7ab7b0294d20142596b0bb3706629

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