Skip to main content

Sov Campaign Timer for Alliance Auth

Project description

AA Sovereignty Timer

Version License Python Django Code Style: black Automated Checks codecov Translation status Contributor Covenant Discord

Sovereignty campaign overview for Alliance Auth.



Screenshots

AA Sov Timer Dashboard (Light Mode)

AA Sov Timer Dashboard (Light Mode)

AA Sov Timer Dashboard (Dark Mode)

AA Sov Timer Dashboard (Dark Mode)

Installation

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

If you want to help to translate this app or improve existing translations, join our team of translators over on Weblate!

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


Release history Release notifications | RSS feed

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-1.12.0.tar.gz (585.0 kB view details)

Uploaded Source

Built Distribution

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

aa_sov_timer-1.12.0-py3-none-any.whl (614.7 kB view details)

Uploaded Python 3

File details

Details for the file aa_sov_timer-1.12.0.tar.gz.

File metadata

  • Download URL: aa_sov_timer-1.12.0.tar.gz
  • Upload date:
  • Size: 585.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for aa_sov_timer-1.12.0.tar.gz
Algorithm Hash digest
SHA256 7f5d85cba13f45069f5c8ed8c4d6b71b1e6dffab04171a01fe6ae7874105a774
MD5 d6a05772e36b97e24dc6129c21963fae
BLAKE2b-256 98d8965673460847b36cdc1fc42383c732ca4ce0ffb27e3ffe653a830dac68c5

See more details on using hashes here.

File details

Details for the file aa_sov_timer-1.12.0-py3-none-any.whl.

File metadata

  • Download URL: aa_sov_timer-1.12.0-py3-none-any.whl
  • Upload date:
  • Size: 614.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for aa_sov_timer-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c32627c3860721a36071d239e42c0b99e3881d993ba22e37a6ba4061d75c0545
MD5 a19059a6fa7e87de2f20cf9e3cf00ea0
BLAKE2b-256 870bdab5d825f53e3decdcd7650d37e0467029eb79b050acd5e8a6fa8051eaed

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