Metadata-Version: 2.4
Name: skyhook-timer
Version: 0.0.66
Summary: A Skyhook Timer app for Alliance Auth.
Author-email: kjelpw <kjelpw@protonmail.com>
License: Copyright 2024 Kjel Pettenger-Willey
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/kjelpw/skyhook-app
Project-URL: Source, https://github.com/kjelpw/skyhook-app
Keywords: allianceauth,eve-online,skyhook,timers
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django>=3.2
Requires-Dist: discord.py>=2.4.0
Dynamic: license-file

# skyhook-app
[python release](https://pypi.org/project/skyhook-timer/)

Plugin for tracking Skyhook timers in [Alliance Auth](https://allianceauth.readthedocs.io/en/v4.4.2/index.html)

## Contents

- [Key Features](#key-features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Permissions](#permissions)

## Key Features
* Adding a table entry with system name, planet, and countdown time remaining
* Alliance Auth nav menu count of Skyhooks close to their vulnerable timer
* Discord webhook integration

## Screenshots

### View timers
![image](https://github.com/user-attachments/assets/12dc48a9-6491-4fc8-bd1a-ce80461d4da7)

### Add a timer (or update an existing one)
![image](https://github.com/user-attachments/assets/0f217720-e334-466c-bc4b-b0d154e3dbab)

### Admin view
![image](https://github.com/user-attachments/assets/6e31a26f-eefa-4ed9-8882-145eeb7e1e61)


## Installation

### 1 - Install app

Install into your Alliance Auth virtual environment from PyPI:

```bash
pip install skyhook-timer
```

### 2 - Configure AA settings

in local.py:
Add `'skyhook_timer'` to `INSTALLED_APPS`
Add `SKYHOOK_WEBHOOK_URL = <your-discord-webhook-here>`
Add
```
CELERYBEAT_SCHEDULE['notify_skyhook_timer'] = {
    'task': 'skyhook_timer.tasks.notify_skyhook_timer',
    'schedule': crontab(minute='*'),  # Runs every minute
}
```

### 3 - Finalize installation into AA

Run migrations & copy static files

```bash
python manage.py migrate
python manage.py collectstatic
```

Restart your supervisor services for AA

### 4 - Setup permissions

Now you can access Alliance Auth and setup permissions for your users. See below

## Permissions

This is an overview of all permissions used by this app:

Name | Purpose | Code
-- | -- | --
Can add skyhook timer | Can create a unique skyhook timer with system/planet and time. If the system/planet timer exists already it overwrites | add_skyhooktimer
Can view skyhook timer | Allows viewing of the nav menu link, and rendering of the skyhook timer page. This should be added to all users/members/states/groups that should be able to view skyhook timers | view_skyhooktimer

# CHANGELOG

### 0.0.66
- Show expiration timestamp for expired timers
- Display time elapsed since expiration (days, hours, minutes, seconds)

### 0.0.65
- Update html to Alliance Auth v5
- Add Discord webhook functionality

### 0.0.49
- Better Skyhook Adding, matches ingame time system.
- Changed default permissions

### 0.0.43
- Limited stable release
