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

ko-fi

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


Features

  • Corporation Tax System
    • Member Tracking
      • Check Member is registred in Auth
      • Check Member is Alt Char
    • Payment System
      • Allocate User from Member Tracking
      • Automatic Payment Tracking
      • Automatic Payment Approvment
      • Filtering Amount, Reason, Date
        • Support Hooks for Add more Filters
    • Payments
      • Track Payments that meets filters
    • Log System
    • Logs Actions from Administration Section

Upcoming

  • Notify via Discord each Month
  • Alliance level tax system

Screenshots

Administration View

Screenshot

Account User Payments History

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 'allianceauth.corputils', to INSTALLED_APPS
  • 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": crontab(minute=0, hour="*/1"),
}

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 Users with this permission can add corporation.
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.

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_LOGGER_USE: True / False - Set to use own Logger File
  • TAXSYSTEM_CORP_MEMBERS_SKIP_DATE: 1 - Set Skip Task Time in Hours
  • TAXSYSTEM_CORP_WALLET_SKIP_DATE: 1 - Set Skip Task Time in Hours
  • TAXSYSTEM_CORP_PAYMENTS_SKIP_DATE: 1 - Set Skip Task Time in Hours
  • TAXSYSTEM_CORP_PAYMENT_SYSTEM_SKIP_DATE: 1 - Set Skip Task Time in Hours

If you set up TAXSYSTEM_LOGGER_USE to True you need to add the following code below and ensure you have permission on logs folder:

LOGGING_TAXSYSTEM = {
    "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,
        },
    },
    "loggers": {
        "taxsystem": {
            "handlers": ["taxsystem_file", "console"],
            "level": "INFO",
        },
    },
}
LOGGING["handlers"].update(LOGGING_TAXSYSTEM["handlers"])
LOGGING["loggers"].update(LOGGING_TAXSYSTEM["loggers"])

[!NOTE] Contributing You want to improve the project? Just Make a Pull Request with the Guidelines. We Using pre-commit

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-0.5.4.tar.gz (506.1 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-0.5.4-py3-none-any.whl (585.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa_taxsystem-0.5.4.tar.gz
  • Upload date:
  • Size: 506.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for aa_taxsystem-0.5.4.tar.gz
Algorithm Hash digest
SHA256 4b141dc07a5f6f855c82719a2e43c5d5d9a85593201f210049ec63c1fb9ab454
MD5 9ce3556abebe55fafde9f097d48e3119
BLAKE2b-256 308200671ae0fffc4fda0b14073d05a10f74ad0af52404948e947976e99864e8

See more details on using hashes here.

File details

Details for the file aa_taxsystem-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: aa_taxsystem-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 585.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for aa_taxsystem-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7dc1f9916619741dd3a55862ef6912d54c9e843e99312bad585f1109195590b3
MD5 e7f74a065b747cfc4038ccfadad7381f
BLAKE2b-256 e0b3cd000fb0be5bd099400d429ce09855fd355ec3928e32a724769d33f1275e

See more details on using hashes here.

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