Browse Apps

AA Squads

Squads plugin app for Alliance Auth


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

No reviews yet...

Python Requirements

Required Python packages to be installed and other Python requirement.

App Dependencies


Required apps:

Used by apps:

    -

Dependencies to other apps registered in this app directory.

Classifiers

  • Environment :: Web Environment
  • Framework :: Django
  • Framework :: Django :: 4.0
  • Framework :: Django :: 4.2
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Operating System :: OS Independent
  • Programming Language :: Python
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: 3.10
  • Programming Language :: Python :: 3.11
  • Programming Language :: Python :: 3.12
  • Programming Language :: Python :: 3.8
  • Programming Language :: Python :: 3.9
  • Topic :: Internet :: WWW/HTTP
  • Topic :: Internet :: WWW/HTTP :: Dynamic Content

Version

0.2.4.1

License

MIT License

Homepage

  https://github.com/Geuthur/aa-squads

PyPI

  https://pypi.org/project/aa-squads/

Last updated

2 months, 3 weeks ago

First published

3 months, 1 week ago

Category

Plugin Apps

Rating

-

Authors

Geuthur

Maintainers

Geuthur Geuthur

Please login to see more options.