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=0, hour="*/1"),
}

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 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_LOGGER_USE Set to use own Logger File True/False False
SKILLFARM_STALE_STATUS Set the Stale Status for Skillfarm Character in hours 3
SKILLFARM_PRICE_SOURCE_ID Set Station ID for fetching base prices. Default is Jita 60003760

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.5.3.tar.gz (398.8 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.3-py3-none-any.whl (462.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa_skillfarm-0.5.3.tar.gz
  • Upload date:
  • Size: 398.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for aa_skillfarm-0.5.3.tar.gz
Algorithm Hash digest
SHA256 75eec67ab9290d7cce730057f179e7cf8dab27d019f2192243977d2ece73b80b
MD5 8076ca4ef640e7586dc842a594703b07
BLAKE2b-256 d5c4ff0fb19672ed05899ba934135a445cc739a14e961a35883faad715b0317e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aa_skillfarm-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 462.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for aa_skillfarm-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a697dc88d15e77786d621d64de7770a152573b34a0c0e20e2218be590dc0694d
MD5 d3167befaf941ba31ab04115327e7629
BLAKE2b-256 d6f84defc6525f00cace7f6764f428b2a110ae7786108993e2ec2d0ef882ff34

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