Catalog PyPI
PACKAGE EXPLORERView in registry

aa-squads

PyPI

Squads plugin app for Alliance Auth

Versions collected1
Direct dependencies9From release 0.2.4.1
Last observed20 Oct, 17:04 UTC

README

Version 0.2.4.1 documentation

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

IDDescription
basic_accessCan access the Squads moduleAll Members with the Permission can access the Squads.
squad_managerCan Create / Manage SquadsManage Squads like Edit, Create Squads, Approve, Decline Request, etc.
squad_adminCan View All SquadsCan 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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
0.2.4.128 Jun 20249

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
geuthur/aa-squads

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:04 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:5c32729d420072c0e4df484af0b9b9d6b3bb68ba6177da9f6cd4535a0c1a5fd0