aa-hangar-ready 0.3.1__tar.gz

aa_hangar_ready-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AA Hangar Ready Contributors
+
+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.

aa_hangar_ready-0.3.1/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: aa-hangar-ready
+Version: 0.3.1
+Summary: AA Hangar Ready - Alliance Auth Plugin
+Author-email: Milkshak3s <milkshak3s@pm.me>
+Requires-Python: ~=3.8
+Description-Content-Type: text/markdown
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+License-File: LICENSE
+Requires-Dist: allianceauth>=4.0.0
+Requires-Dist: django-esi>=7.0.0
+Requires-Dist: django>=4.0
+Requires-Dist: django-eveuniverse>=1.0.0
+Requires-Dist: black>=24.0.0 ; extra == "dev"
+Requires-Dist: coverage>=7.0.0 ; extra == "dev"
+Requires-Dist: django-webtest ; extra == "dev"
+Requires-Dist: flake8>=7.0.0 ; extra == "dev"
+Requires-Dist: isort>=5.13.0 ; extra == "dev"
+Requires-Dist: pylint-django>=2.5.0 ; extra == "dev"
+Requires-Dist: pytest>=8.0.0 ; extra == "dev"
+Requires-Dist: pytest-django>=4.0.0 ; extra == "dev"
+Project-URL: Documentation, https://github.com/Milkshak3s/aa-hangar-ready
+Project-URL: Homepage, https://github.com/Milkshak3s/aa-hangar-ready
+Project-URL: Source, https://github.com/Milkshak3s/aa-hangar-ready
+Project-URL: Tracker, https://github.com/Milkshak3s/aa-hangar-ready/issues
+Provides-Extra: dev
+
+# AA Hangar Ready
+
+[![Version](https://img.shields.io/pypi/v/aa-hangar-ready?label=release)](https://pypi.org/project/aa-hangar-ready/)
+[![License](https://img.shields.io/github/license/Milkshak3s/aa-hangar-ready)](https://github.com/Milkshak3s/aa-hangar-ready/blob/master/LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/aa-hangar-ready)](https://pypi.org/project/aa-hangar-ready/)
+[![Django](https://img.shields.io/pypi/djversions/aa-hangar-ready?label=django)](https://pypi.org/project/aa-hangar-ready/)
+
+Track member ship assets across your organization. Search for specific ship types and classes in specific hangar locations via ESI.
+
+## Key Features
+
+- 🚀 **Ship Search** - Find who has specific ships or ship classes across all members
+- 📊 **Ship Reports** - Generate custom reports by ship type, class, or location
+- 💾 **Saved Reports** - Save frequently-used reports for quick access
+- 🔄 **Auto-Updates** - Periodic automatic asset updates via Celery
+- 👥 **Admin Tools** - Bulk-add characters, view all tracked characters, fetch structure names
+- 🎨 **Modern UI** - Clean, responsive Bootstrap 5 interface with dark mode support
+
+## Requirements
+
+- Alliance Auth 4.0.0+
+- Python 3.8+
+
+## Installation
+
+### 1. Install Package
+
+```bash
+pip install aa-hangar-ready
+```
+
+### 2. Add to Settings
+
+Add to `INSTALLED_APPS` in your Alliance Auth `local.py`:
+
+```python
+INSTALLED_APPS += [
+    'hangarready',
+]
+```
+
+### 3. Run Migrations
+
+```bash
+python manage.py migrate hangarready
+python manage.py collectstatic --noinput
+```
+
+### 4. Restart Services
+
+```bash
+supervisorctl restart myauth:
+```
+
+### 5. Setup Permissions
+
+Grant permissions in Alliance Auth admin:
+
+| Permission | Purpose |
+|------------|---------|
+| `hangarready.basic_access` | Access the plugin (grant to all members) |
+| `hangarready.view_all_characters` | Admin features - view/manage all characters |
+
+### 6. (Optional) Configure Auto-Updates
+
+Add to `local.py` for automatic asset updates:
+
+```python
+from celery.schedules import crontab
+
+CELERYBEAT_SCHEDULE['hangarready_update_stale_assets'] = {
+    'task': 'hangarready.tasks.update_stale_character_assets',
+    'schedule': crontab(hour='*/6'),  # Every 6 hours
+}
+```
+
+## Usage
+
+### For Members
+
+1. Navigate to **Hangar Ready** in the sidebar
+2. Click **Manage Characters**
+3. Add your characters (requires ESI scope: `esi-assets.read_assets.v1`)
+4. Assets will be fetched and updated automatically
+
+**Search for Ships:**
+- Use the dashboard search form to find ships by type and hangar location
+- Or use **Ship Report** to generate detailed reports by ship class
+
+**Save Reports:**
+- Create custom reports and save them for quick re-running
+
+### For Admins
+
+**Bulk Add Characters:**
+- Click **Bulk Add Characters** on the Manage Characters page
+- Automatically adds all characters that have already granted required ESI scopes
+
+**View All Characters:**
+- Dashboard shows an admin-only section with all tracked characters across all accounts
+- See character ownership, status, and last update times
+
+**Fetch Structure Names:**
+- Click **Fetch Structures** to resolve structure IDs to names via ESI
+- Individual structure name refresh buttons available in search results
+
+## Configuration
+
+Optional settings in `local.py`:
+
+```python
+# Update frequency (hours)
+HANGAR_READY_UPDATE_INTERVAL = 6
+
+# Maximum cache age before marked stale (hours)
+HANGAR_READY_MAX_CACHE_AGE = 24
+```
+
+## ESI Scopes Required
+
+- `esi-assets.read_assets.v1` - Read character assets
+- `esi-universe.read_structures.v1` - Resolve structure names (optional, for better UX)
+
+## Supported Hangar Locations
+
+- Main Hangar
+- Ship Maintenance Bay
+- Fleet Hangar
+- Corp Hangars 1-7
+
+## Troubleshooting
+
+**Assets not updating?**
+- Check Celery is running: `supervisorctl status`
+- Verify ESI token is valid (re-add character if needed)
+- Check Celery logs: `tail -f /var/log/myauth/celery.log`
+
+**Permission denied?**
+- Ensure user has `hangarready.basic_access` permission
+
+**Missing ship types?**
+```bash
+python manage.py eveuniverse_load_types --type_id <TYPE_ID>
+```
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/Milkshak3s/aa-hangar-ready/issues)
+- **Discord**: [Alliance Auth Discord](https://discord.gg/allianceauth)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file
+
+---
+
+**Built for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth)** | Uses [django-esi](https://gitlab.com/allianceauth/django-esi) & [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse)
+

aa_hangar_ready-0.3.1/README.md

@@ -0,0 +1,157 @@
+# AA Hangar Ready
+
+[![Version](https://img.shields.io/pypi/v/aa-hangar-ready?label=release)](https://pypi.org/project/aa-hangar-ready/)
+[![License](https://img.shields.io/github/license/Milkshak3s/aa-hangar-ready)](https://github.com/Milkshak3s/aa-hangar-ready/blob/master/LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/aa-hangar-ready)](https://pypi.org/project/aa-hangar-ready/)
+[![Django](https://img.shields.io/pypi/djversions/aa-hangar-ready?label=django)](https://pypi.org/project/aa-hangar-ready/)
+
+Track member ship assets across your organization. Search for specific ship types and classes in specific hangar locations via ESI.
+
+## Key Features
+
+- 🚀 **Ship Search** - Find who has specific ships or ship classes across all members
+- 📊 **Ship Reports** - Generate custom reports by ship type, class, or location
+- 💾 **Saved Reports** - Save frequently-used reports for quick access
+- 🔄 **Auto-Updates** - Periodic automatic asset updates via Celery
+- 👥 **Admin Tools** - Bulk-add characters, view all tracked characters, fetch structure names
+- 🎨 **Modern UI** - Clean, responsive Bootstrap 5 interface with dark mode support
+
+## Requirements
+
+- Alliance Auth 4.0.0+
+- Python 3.8+
+
+## Installation
+
+### 1. Install Package
+
+```bash
+pip install aa-hangar-ready
+```
+
+### 2. Add to Settings
+
+Add to `INSTALLED_APPS` in your Alliance Auth `local.py`:
+
+```python
+INSTALLED_APPS += [
+    'hangarready',
+]
+```
+
+### 3. Run Migrations
+
+```bash
+python manage.py migrate hangarready
+python manage.py collectstatic --noinput
+```
+
+### 4. Restart Services
+
+```bash
+supervisorctl restart myauth:
+```
+
+### 5. Setup Permissions
+
+Grant permissions in Alliance Auth admin:
+
+| Permission | Purpose |
+|------------|---------|
+| `hangarready.basic_access` | Access the plugin (grant to all members) |
+| `hangarready.view_all_characters` | Admin features - view/manage all characters |
+
+### 6. (Optional) Configure Auto-Updates
+
+Add to `local.py` for automatic asset updates:
+
+```python
+from celery.schedules import crontab
+
+CELERYBEAT_SCHEDULE['hangarready_update_stale_assets'] = {
+    'task': 'hangarready.tasks.update_stale_character_assets',
+    'schedule': crontab(hour='*/6'),  # Every 6 hours
+}
+```
+
+## Usage
+
+### For Members
+
+1. Navigate to **Hangar Ready** in the sidebar
+2. Click **Manage Characters**
+3. Add your characters (requires ESI scope: `esi-assets.read_assets.v1`)
+4. Assets will be fetched and updated automatically
+
+**Search for Ships:**
+- Use the dashboard search form to find ships by type and hangar location
+- Or use **Ship Report** to generate detailed reports by ship class
+
+**Save Reports:**
+- Create custom reports and save them for quick re-running
+
+### For Admins
+
+**Bulk Add Characters:**
+- Click **Bulk Add Characters** on the Manage Characters page
+- Automatically adds all characters that have already granted required ESI scopes
+
+**View All Characters:**
+- Dashboard shows an admin-only section with all tracked characters across all accounts
+- See character ownership, status, and last update times
+
+**Fetch Structure Names:**
+- Click **Fetch Structures** to resolve structure IDs to names via ESI
+- Individual structure name refresh buttons available in search results
+
+## Configuration
+
+Optional settings in `local.py`:
+
+```python
+# Update frequency (hours)
+HANGAR_READY_UPDATE_INTERVAL = 6
+
+# Maximum cache age before marked stale (hours)
+HANGAR_READY_MAX_CACHE_AGE = 24
+```
+
+## ESI Scopes Required
+
+- `esi-assets.read_assets.v1` - Read character assets
+- `esi-universe.read_structures.v1` - Resolve structure names (optional, for better UX)
+
+## Supported Hangar Locations
+
+- Main Hangar
+- Ship Maintenance Bay
+- Fleet Hangar
+- Corp Hangars 1-7
+
+## Troubleshooting
+
+**Assets not updating?**
+- Check Celery is running: `supervisorctl status`
+- Verify ESI token is valid (re-add character if needed)
+- Check Celery logs: `tail -f /var/log/myauth/celery.log`
+
+**Permission denied?**
+- Ensure user has `hangarready.basic_access` permission
+
+**Missing ship types?**
+```bash
+python manage.py eveuniverse_load_types --type_id <TYPE_ID>
+```
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/Milkshak3s/aa-hangar-ready/issues)
+- **Discord**: [Alliance Auth Discord](https://discord.gg/allianceauth)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file
+
+---
+
+**Built for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth)** | Uses [django-esi](https://gitlab.com/allianceauth/django-esi) & [django-eveuniverse](https://gitlab.com/ErikKalkoken/django-eveuniverse)

aa_hangar_ready-0.3.1/hangarready/__init__.py

@@ -0,0 +1,12 @@
+"""
+AA Hangar Ready - Alliance Auth Plugin
+
+Tracks character assets via ESI to check which characters have specific ships
+in specific hangar locations.
+"""
+
+default_app_config = "hangarready.apps.HangarReadyConfig"
+
+__version__ = "0.3.1"
+__title__ = "Hangar Ready"
+__description__ = "Alliance Auth plugin to track character ship assets in hangars via ESI"

aa_hangar_ready-0.3.1/hangarready/admin.py

@@ -0,0 +1,86 @@
+"""Django admin configuration for Hangar Ready"""
+
+from django.contrib import admin
+
+from .models import AssetItem, CharacterAssets, Location, SavedSearch
+
+
+@admin.register(CharacterAssets)
+class CharacterAssetsAdmin(admin.ModelAdmin):
+    """Admin for CharacterAssets model"""
+
+    list_display = [
+        "character",
+        "token_character",
+        "last_update",
+        "is_active",
+        "has_error",
+    ]
+    list_filter = ["is_active", "last_update"]
+    search_fields = [
+        "character__character_name",
+        "token_character__user__username",
+    ]
+    readonly_fields = ["last_update", "update_error"]
+    raw_id_fields = ["character", "token_character"]
+
+    def has_error(self, obj):
+        """Check if last update had error"""
+        return bool(obj.update_error)
+
+    has_error.boolean = True
+    has_error.short_description = "Error"
+
+
+@admin.register(AssetItem)
+class AssetItemAdmin(admin.ModelAdmin):
+    """Admin for AssetItem model"""
+
+    list_display = [
+        "type_name",
+        "character_name",
+        "location_flag",
+        "location_name",
+        "quantity",
+        "is_ship",
+    ]
+    list_filter = ["is_ship", "location_flag", "location_type"]
+    search_fields = [
+        "type_name",
+        "character_assets__character__character_name",
+        "location_name",
+    ]
+    readonly_fields = ["item_id", "type_id", "type_name"]
+    raw_id_fields = ["character_assets"]
+
+    def character_name(self, obj):
+        """Get character name"""
+        return obj.character_assets.character.character_name
+
+    character_name.short_description = "Character"
+    character_name.admin_order_field = "character_assets__character__character_name"
+
+
+@admin.register(SavedSearch)
+class SavedSearchAdmin(admin.ModelAdmin):
+    """Admin for SavedSearch model"""
+
+    list_display = ["name", "user", "created_at", "updated_at"]
+    list_filter = ["created_at", "updated_at"]
+    search_fields = ["name", "user__username"]
+    readonly_fields = ["created_at", "updated_at"]
+    raw_id_fields = ["user"]
+
+
+@admin.register(Location)
+class LocationAdmin(admin.ModelAdmin):
+    """Admin for Location model"""
+
+    list_display = ["name", "location_id", "location_type", "last_updated"]
+    list_filter = ["location_type", "last_updated"]
+    search_fields = ["name", "location_id"]
+    readonly_fields = ["last_updated"]
+
+    def has_add_permission(self, request):
+        """Locations are auto-populated, disable manual add"""
+        return False

aa_hangar_ready-0.3.1/hangarready/app_settings.py

@@ -0,0 +1,34 @@
+"""Application settings for Hangar Ready"""
+
+from django.conf import settings
+
+# How often to update character assets (in hours)
+HANGAR_READY_UPDATE_INTERVAL = getattr(settings, "HANGAR_READY_UPDATE_INTERVAL", 6)
+
+# Maximum age of cached asset data before requiring refresh (in hours)
+HANGAR_READY_MAX_CACHE_AGE = getattr(settings, "HANGAR_READY_MAX_CACHE_AGE", 24)
+
+# Hangar location flags mapping
+HANGAR_FLAGS = {
+    "Hangar": "Main Hangar",
+    "ShipHangar": "Ship Maintenance Bay",
+    "FleetHangar": "Fleet Hangar",
+    "CorpSAG1": "Corp Hangar 1",
+    "CorpSAG2": "Corp Hangar 2",
+    "CorpSAG3": "Corp Hangar 3",
+    "CorpSAG4": "Corp Hangar 4",
+    "CorpSAG5": "Corp Hangar 5",
+    "CorpSAG6": "Corp Hangar 6",
+    "CorpSAG7": "Corp Hangar 7",
+    "HangarAll": "All Hangars",
+}
+
+# Ship category ID from EVE SDE
+SHIP_CATEGORY_ID = 6
+
+# ESI required scopes
+ESI_SCOPE_ASSETS = "esi-assets.read_assets.v1"
+ESI_SCOPE_STRUCTURES = "esi-universe.read_structures.v1"
+
+# Combined scopes for full functionality
+ESI_SCOPES_ALL = [ESI_SCOPE_ASSETS, ESI_SCOPE_STRUCTURES]

aa_hangar_ready-0.3.1/hangarready/apps.py

@@ -0,0 +1,18 @@
+"""Django app configuration for Hangar Ready"""
+
+from django.apps import AppConfig
+
+from . import __version__
+
+
+class HangarReadyConfig(AppConfig):
+    """Django app configuration"""
+
+    name = "hangarready"
+    label = "hangarready"
+    verbose_name = f"Hangar Ready v{__version__}"
+
+    def ready(self):
+        """App initialization"""
+        # Import signals to register them
+        from . import signals  # noqa: F401

aa_hangar_ready-0.3.1/hangarready/auth_hooks.py

@@ -0,0 +1,51 @@
+"""Alliance Auth hooks for Hangar Ready"""
+
+from allianceauth import hooks
+from allianceauth.services.hooks import MenuItemHook, UrlHook
+
+from . import urls
+from .app_settings import ESI_SCOPES_ALL
+
+
+class HangarReadyMenuItem(MenuItemHook):
+    """Menu item hook for Hangar Ready"""
+
+    def __init__(self):
+        MenuItemHook.__init__(
+            self,
+            "Hangar Ready",
+            "fa-solid fa-warehouse",
+            "hangarready:index",
+            navactive=["hangarready:"],
+        )
+
+    def render(self, request):
+        """Check permissions before rendering"""
+        if request.user.has_perm("hangarready.basic_access"):
+            return MenuItemHook.render(self, request)
+        return ""
+
+
+@hooks.register("menu_item_hook")
+def register_menu():
+    """Register menu item"""
+    return HangarReadyMenuItem()
+
+
+@hooks.register("url_hook")
+def register_urls():
+    """Register URL patterns"""
+    return UrlHook(urls, "hangarready", r"^hangarready/")
+
+
+@hooks.register("secure_group_filters")
+def register_secure_group_filters():
+    """Register required ESI scopes for secure groups"""
+    # This makes the scope available for groups to require
+    return []
+
+
+# Make the required scopes visible to Alliance Auth
+def get_required_scopes():
+    """Return list of required ESI scopes"""
+    return ESI_SCOPES_ALL