Skip to main content

Tax System module for Alliance Auth

Project description

Tax System module for AllianceAuth.

Release Licence Python Django pre-commit.ci status Code style: black Tests codecov Translation status Discord

ko-fi

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


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

Upcoming

  • Notify via Discord
  • Data export functionality

Screenshots

Administration View

Screenshot

Account User Payments History

Screenshot

Tax Filters

Screenshot

Payments Details

Screenshot

Payments

Screenshot

Installation

[!NOTE] AA Tax System needs at least Alliance Auth v4.6.0 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 'eveuniverse', to INSTALLED_APPS
  • 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["taxsystem_update_all_taxsytem"] = {
    "task": "taxsystem.tasks.update_all_taxsytem",
    "schedule": 1800,
}

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.

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

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_taxsystem-2.0.0.tar.gz (564.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_taxsystem-2.0.0-py3-none-any.whl (674.6 kB view details)

Uploaded Python 3

File details

Details for the file aa_taxsystem-2.0.0.tar.gz.

File metadata

  • Download URL: aa_taxsystem-2.0.0.tar.gz
  • Upload date:
  • Size: 564.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_taxsystem-2.0.0.tar.gz
Algorithm Hash digest
SHA256 a1c092e859747b200118496072b0393dc8bbf3c7059992a319fc8be4a812efd9
MD5 db4b59ca33e6ec0a3b3b03f82cfa07cd
BLAKE2b-256 c19ecfc29cc1a3ad11ef55ce80925e84fc67d8640eb1c9f47fbacd25e127326c

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_taxsystem-2.0.0.tar.gz:

Publisher: release.yml on Geuthur/aa-taxsystem

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_taxsystem-2.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for aa_taxsystem-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 612129916b31ac89b9ad7e9ebeb094dcc0f41afe6182142a8d7609440f8ea53f
MD5 d217d8e5363186b620db1805895a3ca8
BLAKE2b-256 467d350c443e870e91a6911ffefe282bcff4583ae0cd7a3ad97b1110bd031dd0

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_taxsystem-2.0.0-py3-none-any.whl:

Publisher: release.yml on Geuthur/aa-taxsystem

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