aa-ledger 1.0.0b2

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

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 0 - Check dependencies are installed
    • Step 1 - Install the Package
    • Step 2 - Configure Alliance Auth
    • Step 3 - Add the Scheduled Tasks and Settings
    • Step 4 - Migration to AA
    • 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 v4.6.0 Please make sure to update your Alliance Auth before you install this APP

Step 0 - Check dependencies are installed

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

Step 2 - Configure Alliance Auth

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

• Add 'ledger', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

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

CELERYBEAT_SCHEDULE["ledger_character_audit_update_subset_characters"] = {
    "task": "ledger.tasks.update_subset_characters",
    "schedule": 1800,
}
CELERYBEAT_SCHEDULE["ledger_corporation_audit_update_subset_corporations"] = {
    "task": "ledger.tasks.update_subset_corporations",
    "schedule": 1800,
}
CELERYBEAT_SCHEDULE["ledger_check_planetary_alarms"] = {
    "task": "ledger.tasks.check_planetary_alarms",
    "schedule": 10800,
}

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

ID	Description
basic_access	Can access the Ledger module	All Members with the Permission can access the Ledger.
advanced_access	Can access Corporation and Alliance Ledger	Can see Corporation & Alliance Ledger.
manage_access	Can Manage Ledger	Can add/manage Corporations, Alliances.
char_audit_manager	Has Access to all characters for own Corp	Can see all Characters from Corps he is
char_audit_admin_manager	Has Access to all Characters	Can see all Characters.
corp_audit_manager	Has Access to own Corporations	Can see own Corporations.
corp_audit_admin_manager	Has Access to all Corporations	Can see all Corporations.

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

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