https://github.com/ppfeufer/aa-sov-timer

allianceauth django python sovereignty-timer
Last synced: about 1 month ago
JSON representation
Host: GitHub
URL: https://github.com/ppfeufer/aa-sov-timer
Owner: ppfeufer
License: gpl-3.0
Created: 2020-11-10T00:36:03.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2025-04-07T20:39:32.000Z (12 months ago)
Last Synced: 2025-04-07T21:34:57.548Z (12 months ago)
Topics: allianceauth, django, python, sovereignty-timer
Language: Python
Homepage:
Size: 3.79 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

          # AA Sovereignty Timer

[![Version](https://img.shields.io/pypi/v/aa-sov-timer?label=release "Version")](https://pypi.org/project/aa-sov-timer/)

[![License](https://img.shields.io/badge/license-GPLv3-green "License")](https://pypi.org/project/aa-sov-timer/)

[![Python](https://img.shields.io/pypi/pyversions/aa-sov-timer "Python")](https://pypi.org/project/aa-sov-timer/)

[![Django](https://img.shields.io/pypi/djversions/aa-sov-timer?label=django "Django")](https://pypi.org/project/aa-sov-timer/)

![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ppfeufer/aa-sov-timer/master.svg)](https://results.pre-commit.ci/latest/github/ppfeufer/aa-sov-timer/master)

[![Code Style: black](https://img.shields.io/badge/code%20style-black-000000.svg "Code Style: black")](http://black.readthedocs.io/en/latest/)

[![Automated Checks](https://github.com/ppfeufer/aa-sov-timer/actions/workflows/automated-checks.yml/badge.svg "Automated Checks")](https://github.com/ppfeufer/aa-sov-timer/actions/workflows/automated-checks.yml)

[![codecov](https://codecov.io/gh/ppfeufer/aa-sov-timer/branch/master/graph/badge.svg?token=J9PBF0HM8C "codecov")](https://codecov.io/gh/ppfeufer/aa-sov-timer)

[![Translation status](https://weblate.ppfeufer.de/widget/alliance-auth-apps/aa-sov-timer/svg-badge.svg)](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg "Contributor Covenant")](https://github.com/ppfeufer/aa-sov-timer/blob/master/CODE_OF_CONDUCT.md)

[![Discord](https://img.shields.io/discord/399006117012832262?label=discord)](https://discord.gg/fjnHAmk)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N8CL1BY)

Sovereignty campaign overview for Alliance Auth.

______________________________________________________________________

- [Screenshots](#screenshots)

  - [All Timers](#all-timers)

  - [Upcoming Timers (Filtered)](#upcoming-timers-filtered)

  - [Active Timers (Filtered)](#active-timers-filtered)

- [Installation](#installation)

  - [Bare Metal Installation](#bare-metal-installation)

    - [Step 1: Installing the App](#step-1-installing-the-app)

    - [Step 2: Update Your AA Settings](#step-2-update-your-aa-settings)

    - [Step 3: Finalizing the Installation](#step-3-finalizing-the-installation)

    - [Step 4: Preload EVE SDE Data](#step-4-preload-eve-sde-data)

    - [Step 5: Restart Supervisor](#step-5-restart-supervisor)

  - [Docker Installation](#docker-installation)

    - [Step 1: Add the App](#step-1-add-the-app)

    - [Step 2: Update Your AA Settings](#step-2-update-your-aa-settings-1)

    - [Step 3: Build Auth and Restart Your Containers](#step-3-build-auth-and-restart-your-containers)

    - [Step 4: Finalizing the Installation](#step-4-finalizing-the-installation)

  - [Common Steps / Configuration](#common-steps--configuration)

    - [(Optional) Allow Public Views](#optional-allow-public-views)

- [Updating](#updating)

  - [Bare Metal Installation](#bare-metal-installation-1)

  - [Docker Installation](#docker-installation-1)

  - [Common Steps](#common-steps)

- [Changelog](#changelog)

- [Translation Status](#translation-status)

- [Contributing](#contributing)

______________________________________________________________________

## Screenshots

### All Timers

![AA Sov Timer DashboardAA Sov Timer (All Timers)](https://raw.githubusercontent.com/ppfeufer/aa-sov-timer/master/docs/images/presentation/aa-sov-timer.jpg "AA Sov Timer (All Timers)")

### Upcoming Timers (Filtered)

![AA Sov Timer (Upcoming Timers)](https://raw.githubusercontent.com/ppfeufer/aa-sov-timer/master/docs/images/presentation/aa-sov-timer-upcoming-filtered.jpg "AA Sov Timer (Upcoming Timers)")

### Active Timers (Filtered)

![AA Sov Timer (Active Timers)](https://raw.githubusercontent.com/ppfeufer/aa-sov-timer/master/docs/images/presentation/aa-sov-timer-active-filtered.jpg "AA Sov Timer (Active Timers)")

## Installation

> [!IMPORTANT]

>

> Please make sure you meet all preconditions before you proceed.

> [!IMPORTANT]

>

> This app is utilising features that are only available in Alliance Auth >= 4.12.0.

> Please make sure to update your Alliance Auth instance before installing this app,

> otherwise, an update to Alliance Auth will be pulled in unsupervised.

- 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](https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html) for details)

### Bare Metal Installation

#### Step 1: Installing the App

Make sure you're in the virtual environment (venv) of your Alliance Auth installation.

Then install the latest version:

```shell

pip install aa-sov-timer==4.0.1

```

#### Step 2: Update Your AA Settings

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

- Modify `INSTALLED_APPS` to include the following entries:

  ```python

  INSTALLED_APPS = [

      # ...

      "eve_sde",  # Only if not already added for another app

      "sovtimer",

      # ...

  ]

  # This line right below the `INSTALLED_APPS` list, and only if not already added for another app

  INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

  ```

- Add the Scheduled Tasks

  ```python

  if "sovtimer" in INSTALLED_APPS:

      # 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,

      }

  if "eve_sde" in INSTALLED_APPS:

      # Run at 12:00 UTC each day

      CELERYBEAT_SCHEDULE["EVE SDE :: Check for SDE Updates"] = {

          "task": "eve_sde.tasks.check_for_sde_updates",

          "schedule": crontab(minute="0", hour="12"),

      }

  ```

#### Step 3: Finalizing the Installation

Copy static files and run migrations

```shell

python manage.py collectstatic

python manage.py migrate

```

#### Step 4: Preload EVE SDE Data

AA Sovereignty Timer uses EVE SDE data to map IDs to names for solar systems,

regions and constellations. So you need to preload some data from SDE once.

If you already have run this command, you can skip this step.

```shell

python manage.py esde_load_sde

python manage.py sovtimer_load_initial_data

```

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

#### Step 5: Restart Supervisor

Once you have completed all previous steps, restart your AA supervisor service to apply the changes.

**Continue with the [Common Steps / Configuration](#common-steps--configuration) below to finish the installation.**

### Docker Installation

#### Step 1: Add the App

Add the app to your `conf/requirements.txt`:

```text

aa-sov-timer==4.0.1

```

#### Step 2: Update Your AA Settings

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

- Modify `INSTALLED_APPS` to include the following entries:

  ```python

  INSTALLED_APPS = [

      # ...

      "eve_sde",  # Only if not already added for another app

      "sovtimer",

      # ...

  ]

  # This line right below the `INSTALLED_APPS` list, and only if not already added for another app

  INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

  ```

- Add the Scheduled Tasks

  ```python

  if "sovtimer" in INSTALLED_APPS:

      # 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,

      }

  if "eve_sde" in INSTALLED_APPS:

      # Run at 12:00 UTC each day

      CELERYBEAT_SCHEDULE["EVE SDE :: Check for SDE Updates"] = {

          "task": "eve_sde.tasks.check_for_sde_updates",

          "schedule": crontab(minute="0", hour="12"),

      }

  ```

#### Step 3: Build Auth and Restart Your Containers

```shell

docker compose build --no-cache

docker compose --env-file=.env up -d

```

#### Step 4: Finalizing the Installation

Run migrations, copy static files and load EVE SDE data:

```shell

docker compose exec allianceauth_gunicorn bash

auth collectstatic

auth migrate

auth esde_load_sde

auth sovtimer_load_initial_data

```

**Continue with the [Common Steps / Configuration](#common-steps--configuration) below to finish the installation.**

### Common Steps / Configuration

#### (Optional) Allow Public Views

This app supports AA's feature of public views. \

To allow this feature, please add `"sovtimer",`, to the list of `APPS_WITH_PUBLIC_VIEWS` in your `local.py` or `conf/local.py` for Docker:

```python

APPS_WITH_PUBLIC_VIEWS = [

    "sovtimer",

]

```

> [!NOTE]

>

> If you don't have a list for `APPS_WITH_PUBLIC_VIEWS` yet, then add the whole

> block from here.

Restart your supervisor service or your Docker containers to apply the changes.

## Updating

### Bare Metal Installation

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`).

```shell

pip install aa-sov-timer==4.0.1

python manage.py collectstatic

python manage.py migrate

```

Finally, restart your AA supervisor service.

### Docker Installation

To update your existing installation of AA Sovereignty Timer, all you need to do is to update the respective line in your `conf/requirements.txt` file to the latest version.

```text

aa-sov-timer==4.0.1

```

Now rebuild your containers and restart them:

```shell

docker compose build --no-cache

docker compose --env-file=.env up -d

```

After that, run the following commands to update your database and static files:

```shell

docker compose exec allianceauth_gunicorn bash

auth collectstatic

auth migrate

```

### Common Steps

It is possible that some versions need some more changes. Always read the [changelog] and/or [release notes](https://github.com/ppfeufer/aa-sov-timer/releases) to find out more.

## Changelog

See [CHANGELOG.md][changelog] for a detailed list of changes and improvements.

## Translation Status

[![Translation status](https://weblate.ppfeufer.de/widget/alliance-auth-apps/aa-sov-timer/multi-auto.svg)](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)

Do you want to help translate this app into your language or improve the existing

translation? - [Join our team of translators][weblate engage]!

## 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)

[changelog]: https://github.com/ppfeufer/aa-sov-timer/blob/master/CHANGELOG.md

[contribution guidelines]: https://github.com/ppfeufer/aa-sov-timer/blob/master/CONTRIBUTING.md "Contribution Guidelines"

[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/ "Weblate Translations"
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/ppfeufer/aa-sov-timer

Awesome Lists containing this project

README
