Ledger module for AllianceAuth.

Character and Corporation PvE statistics, including detailed information on ESS, Ratting, Trading, Mining, and other activities.

• AA Ledger
  • Features
  • Upcoming
  • Installation
    • Step 1 - Install the Package
    • Step 2 - Configure Alliance Auth
    • Step 3 - Add the Scheduled Tasks and Settings
    • Step 4 - Migrate & Preload EVE SDE Data
      • Step 4.1 - Migrate App and collect static
    • Step 5 - Setting up Permissions
    • Step 6 - (Optional) Settings
  • Highlights
  • Translations
  • Contributing

Features

• Statistics
  • Graphical Statistics
  • Yearly, Monthly, Daily, Hourly
  • Current Day
• Character Ledger
  • Graphical Overview for each Character
    • Graphical Statistics
  • Ratting
  • Encounter Surveillance System Payouts
  • Mining
  • Trading
  • Costs
• Corporation Ledger
  • Graphical Overview for each Member
    • Graphical Statistics
  • Ratting Tax
  • Encounter Surveillance System Tax
  • Industry Tax
• Alliance Ledger
  • Graphical Overview for each Corporation
  • Ratting Tax
  • Encounter Surveillance System Tax
• Planetary Ledger
  • Graphical Overview for each Planet
    • Graphical Statistics
  • Notification if Extractor expire
  • Switchable Notification for each Planet
  • Products Overview
• Events Calender

Upcoming

• Corporation Administration
• Status Update System for each Section
• Costs for Corporation Ledger

Installation

[!NOTE] AA Ledger needs at least Alliance Auth v5 Please make sure to update your Alliance Auth before you install this APP

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-ledger

Step 2 - Configure Alliance Auth

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

INSTALLED_APPS = [
    # other apps
    "eve_sde",  # only if it not already existing
    "ledger",
    # other apps?
]

# This line is right below the `INSTALLED_APPS` list, if not already exist!
INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

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

if "ledger" in INSTALLED_APPS:
    CELERYBEAT_SCHEDULE["AA Ledger :: Update Subset Characters"] = {
        "task": "ledger.tasks.update_subset_characters",
        "schedule": 1800,
    }
    CELERYBEAT_SCHEDULE["AA Ledger :: Update Subset Corporations"] = {
        "task": "ledger.tasks.update_subset_corporations",
        "schedule": 1800,
    }
    CELERYBEAT_SCHEDULE["AA Ledger :: Check Planetary Notification"] = {
        "task": "ledger.tasks.check_planetary_alarms",
        "schedule": 10800,
    }

This also only need to be added if it is not already!

if "eve_sde" in INSTALLED_APPS:
    # Run at 12:00 UTC each day
    CELERYBEAT_SCHEDULE["EVE SDE :: Check for SDE Updates"] = {
        "task": "eve_sde.tasks.check_for_sde_updates",
        "schedule": crontab(minute="0", hour="12"),
    }

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"]["ledger_file"] = {
    "level": "INFO",
    "class": "logging.handlers.RotatingFileHandler",
    "filename": os.path.join(BASE_DIR, "log/ledger.log"),
    "formatter": "verbose",
    "maxBytes": 1024 * 1024 * 5,
    "backupCount": 5,
}
LOGGING["loggers"]["extensions.ledger"] = {
    "handlers": ["ledger_file"],
    "level": "DEBUG",
}

Step 4 - Migrate & Preload EVE SDE Data

AA Ledger uses EVE SDE data to map IDs to names for EveTypes. You will need to preload some data from SDE once.

python manage.py migrate eve_sde
python manage.py esde_load_sde

Step 4.1 - Migrate App and collect static

python manage.py migrate ledger
python manage.py collectstatic --noinput

Step 5 - Setting up Permissions

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

[!IMPORTANT] Character, Corporation, Alliance Ledger only show Data from User has access to advanced_access give User access to see own Corporations he is in

Step 6 - (Optional) Settings

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

• LEDGER_APP_NAME: "YOURNAME" - Set the name of the APP
• LEDGER_TASKS_TIME_LIMIT: 7200 - Defines the time (in seconds) a task will timeout
• LEDGER_USE_COMPRESSED: True - Defines if Mining Ledger use Compressed Price or Raw
• LEDGER_PRICE_PERCENTAGE: 0.9- Defines Mining Price multiplier
• LEDGER_BULK_BATCH_SIZE: 500 - Maximum database batch size per operation. Reduce (e.g., 250) if encountering 'max_allowed_packet' errors, increase for better performance if MySQL is configured with higher limits

Advanced Settings: Stale Status for Each Section

• LEDGER_STALE_TYPES = { "wallet_journal": 30, "wallet_division": 30, "mining_ledger": 30, "planets": 30, "planets_details": 30, } - Defines the stale status duration (in minutes) for each section.

Highlights

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