Catalog PyPI
Back to packageRELEASE DETAILS

0.2.4.1

PyPI

aa-squads

Squads plugin app for Alliance Auth

Published28 Jun 2024
Direct dependencies9
Transitive dependenciesNot calculated

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.

Declared dependencies 9

Native requirements
9 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
aa-memberaudit
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
aa-memberauditruntime
allianceauth-app-utils
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
allianceauth-app-utils>=1.19runtime
allianceauth
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
allianceauth>=4runtime
django-eveuniverse
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
django-eveuniverse>=1.3runtime
django-ninja
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
django-ninjaruntime
pillow
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
pillowruntime
tinycss2
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
tinycss2runtime
coverage
Environment
{
  "extras": "",
  "marker": "extra == \"tests-allianceauth-latest\"",
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
coverage; extra == "tests-allianceauth-latest"runtime
django-webtest
Environment
{
  "extras": "",
  "marker": "extra == \"tests-allianceauth-latest\"",
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
django-webtest; extra == "tests-allianceauth-latest"runtime

Distribution files

2 collected
aa_squads-0.2.4.1-py3-none-any.whl

bdist_wheel · 159.38 KB · Python py3

Source file
aa_squads-0.2.4.1.tar.gz

sdist · 114.6 KB · Python source

Source file

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_version:cdc407fd86cc5045cb28b100eacb0a7c12de8d85fc9b7366efb913bbbde26296

Other collected versions

View all collected versions →