aa-taxsystem 4.0.0

Tax System module for Alliance Auth

Tax System module for AllianceAuth.

A Tax System for Corporation to Monitor Payments like Renting Tax, etc.

---

• AA Tax System
  • Features
  • Upcoming
  • Screenshots
  • Installation
    • 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) Setting up Compatibilies
  • Documentation
  • Translations
  • Contributing

Features

• Multi-Owner Support: Manage both Corporations and Alliances
• Corporation & Alliance Tax System
  • Statistics
    • Owner Information
    • Payments
    • Tax Accounts
    • Division Information
    • Update Status
  • Member Tracking
    • Check Member is registered in Auth
    • Check Member is Alt Char
    • Report members as missing if they leave the corporation/alliance
  • Payment System
    • Allocate User from Member Tracking
    • Automatic Payment Tracking
    • Automatic Payment Approval via Filters
    • Filtering Amount, Reason, Date
  • Payments
    • Track Payments that meets filters
    • Manual approval workflow for unfiltered payments
  • Log System
    • Logs Actions from Administration Section
    • Payment history tracking
  • Notification
    • Discord Notification

Upcoming

• Data export functionality

Screenshots

Administration View

Account User Payments History

Tax Filters

Payments Details

Payments

Installation

[!NOTE] AA Tax System 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-taxsystem

Step 2 - Configure Alliance Auth

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

• Add 'taxsystem', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

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

CELERYBEAT_SCHEDULE["AA Taxsystem :: Update All Tax System"] = {
    "task": "taxsystem.tasks.update_all_taxsytem",
    "schedule": 1800,
}
CELERYBEAT_SCHEDULE["AA Taxsystem :: Sent out Notification"] = {
    "task": "taxsystem.tasks.check_account_deposit",
    "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"]["taxsystem_file"] = {
    "level": "INFO",
    "class": "logging.handlers.RotatingFileHandler",
    "filename": os.path.join(BASE_DIR, "log/taxsystem.log"),
    "formatter": "verbose",
    "maxBytes": 1024 * 1024 * 5,
    "backupCount": 5,
}
LOGGING["loggers"]["extensions.taxsystem"] = {
    "handlers": ["taxsystem_file", "console", "extension_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 Tax System

ID	Description
basic_access	Can access the Tax System module	All Members with the Permission can access the Tax System.
create_access	Can add Corporation/Alliance	Users with this permission can add corporations and alliances.
manage_own_corp	Can manage own Corporation	Users with this permission can manage own corporation.
manage_corps	Can manage all Corporations	Users with this permission can manage all corporations.
manage_own_alliance	Can manage own Alliance	Users with this permission can manage own alliance.
manage_alliances	Can manage all Alliances	Users with this permission can manage all alliances.

Step 6 - (Optional) Setting up Compatibilies

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

• TAXSYSTEM_APP_NAME: "YOURNAME" - Set the name of the APP

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

• TAXSYSTEM_STALE_TYPES = { "wallet": 60, "divisions": 60, "division_names": 60, "members": 60, "payments": 60, "tax_accounts":60, "deadlines": 1440 } - Defines the stale status duration (in minutes) for each section.

• TAXSYSTEM_NOTIFICATION_EXPIRATION_DAYS = 1 - The maximum number of days after which a notification expires and the system resends it.

Documentation

For detailed information on how to use the Tax System, please refer to our comprehensive User Manual.

The manual covers:

• Getting started with the Tax System
• Adding Corporations and Alliances
• Payment System functionality
• Filter configuration
• Account management
• Administration features
• FAQ and troubleshooting

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