Skip to main content

A Skillfarm Tracker Module for Alliance Auth

Project description

Skillfarm module for AllianceAuth.

Release Licence Python Django 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
    • No Active Training hint
  • Filter Skills for each Character
  • Notification System
  • Enable/Disable Characters

Installation

[!NOTE] AA Skillfarm needs at least Alliance Auth v4.6.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="*/15"),
}

CELERYBEAT_SCHEDULE["skillfarm_check_skillfarm_notifications"] = {
    "task": "skillfarm.tasks.check_skillfarm_notifications",
    "schedule": crontab(minute=0, hour="*/24"),
}

CELERYBEAT_SCHEDULE["skillfarm_update_all_prices"] = {
    "task": "skillfarm.tasks.update_all_prices",
    "schedule": crontab(minute=0, hour="0"),
}

Step 3.1 - (Optional) Add own Logger File

To set up the Logger add following code to your local.py Ensure that you have writing permission in logs folder.

LOGGING["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,
}
LOGGING["loggers"]["extensions.skillfarm"] = {
    "handlers": ["skillfarm_file"],
    "level": "DEBUG",
}

Step 4 - Migration to AA

python manage.py collectstatic
python manage.py migrate

Step 4.1 - Create/Load Skillfarm Prices

python manage.py skillfarm_load_prices

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

Setting Name Descriptioon Default
SKILLFARM_APP_NAME Set the name of the APP "Skillfarm"
SKILLFARM_PRICE_SOURCE_ID Set Station ID for fetching base prices. Default is Jita 60003760

Advanced Settings: Stale Status for Each Section

  • SKILLFARM_STALE_TYPES = { "skills": 30, "skillqueue": 30, } - Defines the stale status duration (in minutes) for each section.

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.5.5.tar.gz (406.6 kB view details)

Uploaded Source

Built Distribution

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

aa_skillfarm-0.5.5-py3-none-any.whl (476.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa_skillfarm-0.5.5.tar.gz
  • Upload date:
  • Size: 406.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for aa_skillfarm-0.5.5.tar.gz
Algorithm Hash digest
SHA256 7f14f3e495cd1ea6ebf1a4e84f2708106cee9c08447840fe67e8fbf72f3a4d0b
MD5 f6ee72e226633d74573cf9b02978ef67
BLAKE2b-256 a52fa98d4e4981e8d7a5d6450fa2c365426f20b7596ae3618d2e1254bd112339

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aa_skillfarm-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 476.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for aa_skillfarm-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 155b0ed31b723011affea4895ec20837f26740bde84a005d862e1eda239a0c8b
MD5 2f552a40f6088e663d47ad776480959c
BLAKE2b-256 b9f4a3c09ba42364e99dff140a5c23394c172f750fdbe0cf0f04ba8c243de1e4

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