Skip to main content

Squads plugin app for Alliance Auth

Project description

Squads module for AllianceAuth.

pre-commit.ci status Code style: black Checks codecov

Features

  • Squads with Icons
  • Req. Skills Check
  • Html Supportive Description
  • Overview which User has Req. Skills for Skillsets

Upcoming

  • Asset Check (If the User has the Hull of the Ship).
  • Updating squad membership on state change.

Installation

[!NOTE] AA Squads needs at least Alliance Auth v4.0.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-squads

Step 2 - Configure Alliance Auth

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

  • Add 'eveuniverse', to INSTALLED_APPS
  • Add 'memberaudit', to INSTALLED_APPS
  • Add 'squads', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

At the Moment it is not implemented yet.

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 Squads

ID Description
basic_access Can access the Squads module All Members with the Permission can access the Squads.
admin_access Can Manage Squads Manage Squads Module.
squad_manager Can Create Squads & Manage own Squads Manage Squads like Edit, Create Squads, Approve, Decline Request, etc.

Step 6 - (Optional) Setting up Compatibilies

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

  • SQUADS_APP_NAME: "YOURNAME" - Set the name of the APP
  • SQUADS_LOGGER_USE: True / False - Set to use own Logger File

If you set up SQUADS_LOGGER_USE to True you need to add the following code below:

LOGGING_SQUADS = {
    "handlers": {
        "squads_file": {
            "level": "INFO",
            "class": "logging.handlers.RotatingFileHandler",
            "filename": os.path.join(BASE_DIR, "log/squads.log"),
            "formatter": "verbose",
            "maxBytes": 1024 * 1024 * 5,
            "backupCount": 5,
        },
    },
    "loggers": {
        "squads": {
            "handlers": ["squads_file", "console"],
            "level": "INFO",
        },
    },
}
LOGGING["handlers"].update(LOGGING_SQUADS["handlers"])
LOGGING["loggers"].update(LOGGING_SQUADS["loggers"])

Highlights

Screenshot 2024-06-09 164402 Screenshot 2024-06-09 164408 Screenshot 2024-06-09 164431 Screenshot 2024-06-09 164502 Screenshot 2024-06-09 164516 Screenshot 2024-06-09 164508 Screenshot 2024-06-09 170318

[!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_squads-0.1.3.tar.gz (102.3 kB view hashes)

Uploaded Source

Built Distribution

aa_squads-0.1.3-py3-none-any.whl (135.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page