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.3.tar.gz (97.6 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.3-py3-none-any.whl (120.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autosrp-0.0.3.tar.gz
  • Upload date:
  • Size: 97.6 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.3.tar.gz
Algorithm Hash digest
SHA256 5bc6518d960a98d60ec7a4975ac644f2fe444d97ffcf33ece02bc6d761b659ed
MD5 8dae12eab92334cf5b7231db8259d624
BLAKE2b-256 88c50ee3fa6f35da49ab78ba678e3e213a74607871851d07db6f98caefa93c6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: autosrp-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 120.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e0dd86f3348b612ebe7ccf7a1474e1c30dd6377e71312513307cd4728a59a8c1
MD5 88ae4abfbb7bb5e7492ebc69fe40148e
BLAKE2b-256 2298a2a429cd713641befa4582dcf4ea2ad31514d8efab5264833a194a1042ee

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