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

  • Detailed Squad Information (html)
  • Squad Filters
  • Overview of Members in Squads
  • Check Member States if they met Filters
  • Updating Member States on Filter changes

Upcoming

  • More Filters.
  • Missing Skills can be imported from EVE Online Skillplaner

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

You can change the interval if you want.

CELERYBEAT_SCHEDULE["run_check_squads"] = {
    "task": "squads.tasks.run_check_squads",
    "schedule": crontab(minute=0, hour="*/12"),
}

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.
squad_manager Can Create / Manage Squads Manage Squads like Edit, Create Squads, Approve, Decline Request, etc.
squad_admin Can View All Squads Can View all Squads.

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

[!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.2.4.1.tar.gz (117.3 kB view details)

Uploaded Source

Built Distribution

aa_squads-0.2.4.1-py3-none-any.whl (163.2 kB view details)

Uploaded Python 3

File details

Details for the file aa_squads-0.2.4.1.tar.gz.

File metadata

  • Download URL: aa_squads-0.2.4.1.tar.gz
  • Upload date:
  • Size: 117.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for aa_squads-0.2.4.1.tar.gz
Algorithm Hash digest
SHA256 19f1b25767f1861fff1f9ec18992b99e81819d100e7b4f117a8cd9bc764aea0d
MD5 cee7005eccb16f7b150a9993414a3428
BLAKE2b-256 25f18e6ff3c7f52fc7fe22fdf571b8d56824741e7a47c0621e8c8ee065fd073d

See more details on using hashes here.

File details

Details for the file aa_squads-0.2.4.1-py3-none-any.whl.

File metadata

  • Download URL: aa_squads-0.2.4.1-py3-none-any.whl
  • Upload date:
  • Size: 163.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for aa_squads-0.2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b3f50264bdd219456526d0e70985d6b85d976384f8d21a9edc85f976b8ec212
MD5 d86ba952bae15f9927e616e781565600
BLAKE2b-256 b0cbf71f28492f47d39055ab0129049656c67d8180884e344b49c6f248c17b1e

See more details on using hashes here.

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