Skip to main content

Automatic SRP Review

Project description

Auto SRP

pypi latest version python versions django versions license

A streamlined Ship Replacement Program (SRP) management app for AllianceAuth.

Contents

Overview

Auto SRP helps alliances and corporations manage ship replacement submissions, reviews, and payouts end to end. Automatically. Without user submissions.

This project requires Fittings and EveUniverse to be installed.

Key Features

  • FC-driven submissions

    • Pilots do not submit losses, FCs (or users with the submit permission) create SRP reports.
    • Automatic: paste a zKill “related” link or a (beta) EVE Tools BR link to auto-fill systems and time.
    • Manual: specify systems and time window, the expected doctrine, and eligible alliances/corporations (org filter. fc/Submit SRP
    • FCs have access to see reports they have submitted. fc/My Submissions
  • Doctrine fit matching (https://gitlab.com/colcrunch/fittings)

    • Losses are matched against doctrine fits automatically.
    • Reviewers can change the selected fit and re-run the fit check at any time.
  • Payout calculation and overrides

    • Suggested payouts are computed from base rewards (if configured, otherwise it uses market data) with configurable penalty schemes.
    • Reviewers can override the payout per kill when needed.
    • The application provides a detailed report of the match, including the doctrine, the fit, and the payout. Simply click details.
  • Review workflow

    • Add or remove kills from a report, then approve or reject with optional comments.
    • If the character is attached to the user in AA and they have Discord configured, the user will be notified on approval/rejection (including comments).
      • Users can disable this notification on an individual level. user/Discord
  • Configurable penalties

    • Define penalty schemes (per-missing/wrong module), optionally include rigs/subsystems, and set a max cap.
  • Flexible rewards

    • Set base rewards per doctrine and ship, enabling fixed payouts independent of market prices.
  • Analytics

    • Manager and user-level dashboards: submission counts, payouts, loss values, and trends.
    • Users also have the same stats, but specific to them.

Installation

1. Install the app

Install into your AllianceAuth virtual environment via pip.

pip install autosrp

2. Configure AA settings

  • Add 'autosrp' to INSTALLED_APPS
  • Optionally, configure settings from the Settings section below to enable integrations and tune fit checking

3. Finalize install

Run migrations and collect static files.

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

Then restart your AA services.

Run the following command to create the initial item data.

python manage.py autosrp_preload_data

Once it has finished, you can create the initial price data.

python manage.py refresh_item_prices

Configuring before use

1. Configure Orgranization Filters (done only in the admin menu)

1.1 [99009902] or [99009902, 99009903]

2. Configure Doctrine Base Awards If Needed

3. Configure Penalties If Needed

Updating

pip install -U autosrp

Run migrations and collectstatic.

Settings

Setting Default Description
AUTOSRP_JANICE_API_KEY "" Optional API key for Janice pricing lookups when available.
AUTOSRP_FITCHECK_IGNORE_CATEGORY_IDS {8, 18, 20, 5} Category IDs to ignore during doctrine/fit comparison.

Integrations auto-detection:

  • AA Discordbot: enabled when the aadiscordbot app is installed
  • AA Discord Notify: enabled when the discordnotify app is installed
  • Discord Proxy: detected if discordproxy is installed and importable

Scheduled task for updating prices

CELERYBEAT_SCHEDULE['autosrp_update_all_prices'] = {
    'task': 'autosrp.services.services_update.update_all_prices',
    'schedule': crontab(minute=0, hour=3, day_of_week='sun'),
}

Permissions

Permission Appearance in Admin Description
autosrp.manage autosrp - submission Can manage Auto SRP settings.
autosrp.submit autosrp - submission Can submit Auto SRP requests.
autosrp.review autosrp - submission Can review Auto SRP batches.

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

autosrp-0.0.6.tar.gz (97.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autosrp-0.0.6-py3-none-any.whl (120.7 kB view details)

Uploaded Python 3

File details

Details for the file autosrp-0.0.6.tar.gz.

File metadata

  • Download URL: autosrp-0.0.6.tar.gz
  • Upload date:
  • Size: 97.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for autosrp-0.0.6.tar.gz
Algorithm Hash digest
SHA256 aef32e4f6af25a5cfa5d46fd2943b6eb4195555cbff9d1f7d6b0261242dadb9a
MD5 1b1b8a0fae0f8496af1a960623e8b197
BLAKE2b-256 9ec9a79ee3e77f544afa36ea6f60db045d2e0f003bc1654c93f2131af6f98a62

See more details on using hashes here.

File details

Details for the file autosrp-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: autosrp-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 120.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for autosrp-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 53ad3335e0e0dfc2e208a916d20ea76ee0ef66fc2c9667c9c7450289d4028152
MD5 34a3b2ed631d4c8a503bb290d01836ab
BLAKE2b-256 6738b4930f00bfe6be65795c5ef4e7792b50b9a247bb181df6a2d1e1207a76d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page