Skip to main content

Sov Campaign Timer for Alliance Auth

Project description

AA Sovereignty Timer

Version License Python Django pre-commit pre-commit.ci status Code Style: black Automated Checks codecov Translation status Contributor Covenant Discord

ko-fi

Sovereignty campaign overview for Alliance Auth.



Screenshots

AA Sov Timer Dashboard

AA Sov Timer Dashboard

Installation

[!NOTE]

AA Sov Timer >= 2.0.0 needs at least Alliance Auth v4.0.0!

Please make sure to update your Alliance Auth instance before you install this module or update to the latest version, otherwise an update to Alliance Auth will be pulled in unsupervised.

The last version compatible with Alliance Auth v3 is 1.12.3.

Important: Please make sure you meet all preconditions before you proceed:

  • AA Sovereignty Timer 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)
  • AA Sovereignty Timer needs the app django-eveuniverse to function. Please make sure it is installed before continuing.

Step 1: Installing the App

Make sure you're in the virtual environment (venv) of your Alliance Auth installation. Then install the latest version:

pip install aa-sov-timer

Step 2: Update Your AA Settings

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

  • Add 'eveuniverse', to INSTALLED_APPS
  • Add 'sovtimer', to INSTALLED_APPS

Restart your supervisor

Step 3: Finalizing the Installation

Copy static files and run migrations

python manage.py collectstatic
python manage.py migrate

Step 4: Preload Eve Universe Data

AA Sovereignty Timer uses Eve Universe data to map IDs to names for solar systems, regions and constellations. So you need to preload some data from ESI once. If you already have run this command, you can skip this step.

python manage.py eveuniverse_load_data map
python manage.py sovtimer_load_initial_data

Both commands might take a moment or two, so be patient ...

Step 5: Setting up Permission

Now you can set up permissions in Alliance Auth for your users. Add sovtimer | Sovereignty Timer | Can access the Sovereignty Timer module to the states and/or groups you would like to have access.

Step 6: Keep Campaigns Updated

Add the following scheduled task to your local.py. One done, restart your supervisor.

# AA Sovereignty Timer - Run sovereignty related updates every 30 seconds
CELERYBEAT_SCHEDULE["sovtimer.tasks.run_sov_campaign_updates"] = {
    "task": "sovtimer.tasks.run_sov_campaign_updates",
    "schedule": 30.0,
}

Now your system is updating the sovereignty campaigns every 30 seconds.

Updating

To update your existing installation of AA Sovereignty Timer, first enable your virtual environment.

Then run the following commands from your AA project directory (the one that contains manage.py).

pip install -U aa-sov-timer
python manage.py collectstatic
python manage.py migrate

Finally, restart your AA supervisor services.

Changelog

See CHANGELOG.md

Translation Status

Translation status

Do you want to help translate this app into your language or improve the existing translation? - Join our team of translators!

Contributing

Do you want to contribute to this project? That's cool!

Please make sure to read the Contribution Guidelines.
(I promise, it's not much, just some basics)

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

aa_sov_timer-2.2.1.tar.gz (326.0 kB view hashes)

Uploaded Source

Built Distribution

aa_sov_timer-2.2.1-py3-none-any.whl (364.8 kB view hashes)

Uploaded Python 3

Supported by

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