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 Translation status

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

Translations

Translations

Help us translate this app into your language or improve existing translations. Join our team!"

Contributing

You want to improve the project? Please ensure you read the contribution guidelines

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-1.0.0b1.tar.gz (405.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-1.0.0b1-py3-none-any.whl (471.4 kB view details)

Uploaded Python 3

File details

Details for the file aa_skillfarm-1.0.0b1.tar.gz.

File metadata

  • Download URL: aa_skillfarm-1.0.0b1.tar.gz
  • Upload date:
  • Size: 405.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_skillfarm-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 c0abb2b94c3549468ac67f8de321f68ea36ee0ea99f244a64671b5cab7c31209
MD5 08a6fee16118954eea87d1c3a4c8f90e
BLAKE2b-256 109675b7b30e7214034028123bb48d2a37ecfe5418a1040c54bd6c1424a3103d

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_skillfarm-1.0.0b1.tar.gz:

Publisher: release.yml on Geuthur/aa-skillfarm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aa_skillfarm-1.0.0b1-py3-none-any.whl.

File metadata

  • Download URL: aa_skillfarm-1.0.0b1-py3-none-any.whl
  • Upload date:
  • Size: 471.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_skillfarm-1.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e622930f2459d0e7e9afb4e950d6eb9efc98e5c59ef860b22ddbd12b89f662c
MD5 2b7400484d1b166f27f22722e626cb21
BLAKE2b-256 cfbccdfc165d23988c4bea1f234e92c45ab1bf794e030957a70490d4ace8514c

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_skillfarm-1.0.0b1-py3-none-any.whl:

Publisher: release.yml on Geuthur/aa-skillfarm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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