Skip to main content

Corporation Handouts

AA module for managing corporation handouts and especially to keep track of their fits/ammo to know if they should be fixed.

It also allows to track the fitting of citadels fighters/modules/ammos and the corrections that need to be done.

release python django license

Features:

Screenshots

index view

doctrine view

corrections view

Installation

Step 1 - Check prerequisites

  1. Corporation handouts is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)
  2. The app requires you to have two other applications installed to work properly:
    1. fittings
    2. allianceauth-corp-tools

Make sure to have both properly installed before continuing

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-corphandouts

Step 3 - Configure Auth settings

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

  • Add 'corphandouts' to INSTALLED_APPS
  • Add below lines to your settings file:
CELERYBEAT_SCHEDULE['corphandouts_update_all'] = {
    'task': 'corphandouts.tasks.update_all_doctrine_reports',
    'schedule': crontab(minute='0', hour='*/1'),
}

Step 4 - Finalize App installation

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic --noinput

Restart your supervisor services for Auth.

Admin setup

To set up which doctrines should be verified by this module, you need to create new doctrine reports in the admin panel. YOURAUTH/admin/corphandouts/doctrinereport

All fits you want to check need to already be added in the fitting module to be selected.

When creating a new doctrine, you need to determine:

  • the doctrine name
  • the corporation that has the ships in hangars
  • the location of the doctrine
  • which corp hangar division (a number between one and seven)

After that you can add all the ships that are part of this doctrine. You can optionally specify:

  • how many ships of this type are expected in corp hangars
  • a regex to match ship names

Once the doctrine is saved you can select the doctrine and use an admin action to update it immediately.

Ship name regex

When your doctrine has several ships of the same types but with different fits, or you have more ships of this type in your hangar than the ones of the doctrine, you should consider using a regex to match ship names.

For example, a loki fleet could use both dps loki and logi loki. The DPS loki would be name LOKI DPS and the logi ones LOKI LOGI, entering these values in the regex will only select the ships with this name.
In case you name your ships with number - for example LOKI DPS 0 up to LOKI DPS 9 - you can use a regex to match those LOKI DPS \d.

Citadel fittings

You can setup the module to look for in space citadel fits instead of looking for handouts in corporations hangars. To do so when setting up a doctrine in the admin view set the location to None (usually by leaving it to the -------------------- choice) and set the hangar division to 0.

The citadel fits reports will be accessible through a different menu item called "Citadel Corrections".

Ship name regex can be ignored when working on citadel fits.

Permissions

Handout permissions

Name Description
basic_access Can access the corporation handout module and see doctrines
manager Can view all corporation handouts and citadel fittings

Citadel corrections

This menu item uses a different set of roles.

Name Description
corporation_view Can view citadel corrections from corporations the user has a character in
alliance_view Can view citadel corrections from alliances the user has a character in

Commands

The following commands can be used when running the module:

Name Description
corphandouts_check_all Updates all doctrine reports in the auth

Metadata

Release files for aa-corphandouts 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aa-corphandouts 1.1.0
File Size Uploaded
aa_corphandouts-1.1.0.tar.gz 30.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aa-corphandouts 1.1.0
File Interpreter ABI Platform
aa_corphandouts-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 73.3 kB

Release files / aa_corphandouts-1.1.0.tar.gz

Download URL aa_corphandouts-1.1.0.tar.gz
Size 30.9 kB
Tags Source
SHA-256 checksum
How to use checksums
72ba94e2e01511fa8f37cbd5219665e353dcaa4159f014c14f13424ccf2e9f84
BLAKE2b-256 checksum
How to use checksums
c705c7cfb57beb4abb11856ddb2f74ecc92b0aa297cba0be314372870d089100
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.10.19

Release files / aa_corphandouts-1.1.0-py3-none-any.whl

Download URL aa_corphandouts-1.1.0-py3-none-any.whl
Size 42.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3429c05c9fced93474ac27d940cf25e3c25a2d5a6e817bf4c8acc8a725114876
BLAKE2b-256 checksum
How to use checksums
39b5de360b4d13fc41fb9d800b551d701ae1f0f431cadd01b75f5c2924e9ae80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.10.19
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page