aa-corphandouts 0.1.0__tar.gz

aa_corphandouts-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 T'rahk Rokym
+
+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_corphandouts-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: aa-corphandouts
+Version: 0.1.0
+Summary: Example plugin app for Alliance Auth.
+Author-email: John Doe <john.doe@example.com>, T'rahk Rokym <trahk.rokym@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+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
+Requires-Dist: fittings>=2.1
+Requires-Dist: allianceauth-corptools>=2.9
+Project-URL: Changelog, https://gitlab.com/r0kym/aa-corphandouts/-/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://gitlab.com/r0kym/aa-corphandouts/
+Project-URL: Source, https://gitlab.com/r0kym/aa-corphandouts/
+Project-URL: Tracker, https://gitlab.com/r0kym/aa-corphandouts/-/issues
+
+# Corporation Handouts
+
+*This module is under development. Use at your own risks.*
+
+AA module for managing corporation handouts and especially to keep tracks of their fits/ammo to know if they should be fixed.
+
+[![release](https://img.shields.io/pypi/v/aa-corphandouts?label=release)](https://pypi.org/project/aa-corphandouts/)
+[![python](https://img.shields.io/pypi/pyversions/aa-corphandouts)](https://pypi.org/project/aa-corphandouts/)
+[![django](https://img.shields.io/pypi/djversions/aa-corphandouts?label=django)](https://pypi.org/project/aa-corphandouts/)
+[![license](https://img.shields.io/badge/license-MIT-green)](https://gitlab.com/r0kym/aa-corphandouts/-/blob/master/LICENSE)
+
+## Features:
+
+### Screenshots
+
+## Installation
+
+### Step 1 - Check prerequisites
+
+1. Corporation handouts 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/auth/allianceauth/) for details)
+2. The app requires you to have two other applications installed to work properly:
+   1. [fittings](https://gitlab.com/colcrunch/fittings) installed.
+   2. [allianceauth-corp-tools](https://github.com/Solar-Helix-Independent-Transport/allianceauth-corp-tools/tree/master)
+
+Make sure to have both properly installed before continuing
+
+### Step 2 - Install app
+
+Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
+
+```bash
+pip install aa-corphandouts
+```
+
+### Step 3 - Configure Auth settings
+
+Configure your Auth settings (`local.py`) as follows:
+
+- Add `'corphandouts'` to `INSTALLED_APPS`
+- Add below lines to your settings file:
+
+```python
+```
+
+### Step 4 - Finalize App installation
+
+Run migrations & copy static files
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --noinput
+```
+
+Restart your supervisor services for Auth.
+
+## Permissions
+
+Permissions overview.
+
+| Name                  | Description                                                                                              |
+|-----------------------|----------------------------------------------------------------------------------------------------------|
+
+## Settings
+
+List of settings that can be modified for the application.
+You can alter them by adding them in your `local.py` file.
+
+| Name                                  | Description                                                                                                                                        | Default |
+|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+
+
+
+## Commands
+
+The following commands can be used when running the module:
+
+| Name                                   | Description                                                                   |
+|----------------------------------------|-------------------------------------------------------------------------------|
+

aa_corphandouts-0.1.0/README.md

@@ -0,0 +1,78 @@
+# Corporation Handouts
+
+*This module is under development. Use at your own risks.*
+
+AA module for managing corporation handouts and especially to keep tracks of their fits/ammo to know if they should be fixed.
+
+[![release](https://img.shields.io/pypi/v/aa-corphandouts?label=release)](https://pypi.org/project/aa-corphandouts/)
+[![python](https://img.shields.io/pypi/pyversions/aa-corphandouts)](https://pypi.org/project/aa-corphandouts/)
+[![django](https://img.shields.io/pypi/djversions/aa-corphandouts?label=django)](https://pypi.org/project/aa-corphandouts/)
+[![license](https://img.shields.io/badge/license-MIT-green)](https://gitlab.com/r0kym/aa-corphandouts/-/blob/master/LICENSE)
+
+## Features:
+
+### Screenshots
+
+## Installation
+
+### Step 1 - Check prerequisites
+
+1. Corporation handouts 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/auth/allianceauth/) for details)
+2. The app requires you to have two other applications installed to work properly:
+   1. [fittings](https://gitlab.com/colcrunch/fittings) installed.
+   2. [allianceauth-corp-tools](https://github.com/Solar-Helix-Independent-Transport/allianceauth-corp-tools/tree/master)
+
+Make sure to have both properly installed before continuing
+
+### Step 2 - Install app
+
+Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
+
+```bash
+pip install aa-corphandouts
+```
+
+### Step 3 - Configure Auth settings
+
+Configure your Auth settings (`local.py`) as follows:
+
+- Add `'corphandouts'` to `INSTALLED_APPS`
+- Add below lines to your settings file:
+
+```python
+```
+
+### Step 4 - Finalize App installation
+
+Run migrations & copy static files
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --noinput
+```
+
+Restart your supervisor services for Auth.
+
+## Permissions
+
+Permissions overview.
+
+| Name                  | Description                                                                                              |
+|-----------------------|----------------------------------------------------------------------------------------------------------|
+
+## Settings
+
+List of settings that can be modified for the application.
+You can alter them by adding them in your `local.py` file.
+
+| Name                                  | Description                                                                                                                                        | Default |
+|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+
+
+
+## Commands
+
+The following commands can be used when running the module:
+
+| Name                                   | Description                                                                   |
+|----------------------------------------|-------------------------------------------------------------------------------|

aa_corphandouts-0.1.0/corphandouts/__init__.py

@@ -0,0 +1,6 @@
+"""Example plugin app for Alliance Auth."""
+
+# pylint: disable = invalid-name
+default_app_config = "corphandouts.apps.CorpHandoutsConfig"
+
+__version__ = "0.1.0"

aa_corphandouts-0.1.0/corphandouts/admin.py

@@ -0,0 +1,37 @@
+"""Admin site."""
+
+from corptools.models import CorpAsset, EveLocation
+
+from django import forms
+from django.contrib import admin
+
+from corphandouts.models import DoctrineReport, FittingReport
+
+
+class DoctrineReportForm(forms.ModelForm):
+    class Meta:
+        model = DoctrineReport
+        fields = "__all__"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        asset_locations_names_queryset = (
+            CorpAsset.objects.filter(location_name__isnull=False)
+            .values_list("location_name")
+            .distinct()
+        )
+        asset_locations_queryset = EveLocation.objects.filter(
+            location_id__in=asset_locations_names_queryset, managed=False
+        ).order_by("location_name")
+        # TODO filter out metenoxes
+        self.fields["location"].queryset = asset_locations_queryset
+
+
+class FitInline(admin.TabularInline):
+    model = FittingReport
+
+
+@admin.register(DoctrineReport)
+class DoctrineReportAdmin(admin.ModelAdmin):
+    form = DoctrineReportForm
+    inlines = (FitInline,)

aa_corphandouts-0.1.0/corphandouts/app_settings.py

@@ -0,0 +1,5 @@
+"""App settings."""
+
+from django.conf import settings
+
+EXAMPLE_SETTING_ONE = getattr(settings, "EXAMPLE_SETTING_ONE", None)

aa_corphandouts-0.1.0/corphandouts/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class CorpHandoutsCongif(AppConfig):
+    name = "corphandouts"
+    label = "corphandouts"
+    verbose_name = "corphandouts"

aa_corphandouts-0.1.0/corphandouts/auth_hooks.py

@@ -0,0 +1,35 @@
+from django.utils.translation import gettext_lazy as _
+
+from allianceauth import hooks
+from allianceauth.services.hooks import MenuItemHook, UrlHook
+
+from . import urls
+
+
+class CorporationHandoutMenuItem(MenuItemHook):
+    """This class ensures only authorized users will see the menu entry"""
+
+    def __init__(self):
+        # setup menu entry for sidebar
+        MenuItemHook.__init__(
+            self,
+            _("Corporation handouts"),
+            "fas fa-cube fa-fw",
+            "corphandouts:index",
+            navactive=["corphandouts:"],
+        )
+
+    def render(self, request):
+        if request.user.has_perm("corphandouts.basic_access"):
+            return MenuItemHook.render(self, request)
+        return ""
+
+
+@hooks.register("menu_item_hook")
+def register_menu():
+    return CorporationHandoutMenuItem()
+
+
+@hooks.register("url_hook")
+def register_urls():
+    return UrlHook(urls, "corphandouts", r"^corphandouts/")

aa_corphandouts-0.1.0/corphandouts/corptools.py

@@ -0,0 +1,49 @@
+from corptools.models import CorpAsset, CorporationAudit, EveLocation
+
+from django.db.models import Q, QuerySet
+
+from allianceauth.services.hooks import get_extension_logger
+
+logger = get_extension_logger(__name__)
+
+
+def get_assets_corporation_division(
+    corporation: CorporationAudit, location: EveLocation, hangar_division: int
+) -> QuerySet[CorpAsset]:
+    """Returns a queryset of corporation assets in the specified hangar and location"""
+
+    corp_assets = CorpAsset.objects.filter(corporation=corporation)
+    asset_locations = corp_assets.filter(location_name_id=location.location_id)
+    corp_assets = corp_assets.filter(
+        Q(location_name_id=location.location_id)
+        | Q(location_id__in=asset_locations.values_list("item_id"))
+        | Q(location_id=location.location_id)
+    )
+
+    return corp_assets.filter(location_flag=f"CorpSAG{hangar_division}")
+
+
+def get_ship_fit(ship_item_id: int) -> QuerySet[CorpAsset]:
+    """Returns all known items linked to this ship id"""
+
+    return CorpAsset.objects.filter(location_id=ship_item_id)
+
+
+def update_corp_item_names_bulk(item_name_ids: list[dict]):
+    """
+    Bulk update item names from a list of:
+    [
+        {
+            "item_id": int,
+            "name": str,
+        };
+    ]
+    """
+    logger.debug(item_name_ids)
+    corp_assets = []
+    for item in item_name_ids:
+        corp_asset = CorpAsset.objects.get(item_id=item["item_id"])
+        corp_asset.name = item["name"]
+        corp_assets.append(corp_asset)
+    logger.debug(corp_assets)
+    CorpAsset.objects.bulk_update(corp_assets, ["name"])

aa_corphandouts-0.1.0/corphandouts/esi.py

@@ -0,0 +1,32 @@
+"""ESI interactions"""
+
+from corptools.task_helpers.corp_helpers import get_corp_token
+
+from esi.clients import EsiClientProvider
+
+from allianceauth.services.hooks import get_extension_logger
+
+from . import __version__
+
+logger = get_extension_logger(__name__)
+esi = EsiClientProvider(app_info_text=f"aa-corp-handouts v{__version__}")
+
+
+def get_corporation_asset_names(
+    corporation_id: int, item_ids: list[int]
+) -> list[[int, int]]:
+    """
+    Return names for a set of item ids, which you can get from corporation assets endpoint.
+    """
+    logger.info("Updating names for corp id %d", corporation_id)
+    logger.debug(item_ids)
+
+    req_scopes = ["esi-assets.read_corporation_assets.v1"]
+    req_roles = ["Director"]
+    token = get_corp_token(corporation_id, req_scopes, req_roles)
+
+    return esi.client.Assets.post_corporations_corporation_id_assets_names(
+        corporation_id=corporation_id,
+        item_ids=item_ids,
+        token=token.valid_access_token(),
+    ).result()

aa_corphandouts-0.1.0/corphandouts/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,113 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#: corphandouts/templates/corphandouts/doctrine.html:11
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2025-04-04 20:21+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: corphandouts/auth_hooks.py:16
+#: corphandouts/templates/corphandouts/base.html:5
+msgid "Corporation handouts"
+msgstr ""
+
+#: corphandouts/models.py:27
+msgid "Doctrine name"
+msgstr ""
+
+#: corphandouts/models.py:31
+msgid "Corporation to get the assets from"
+msgstr ""
+
+#: corphandouts/models.py:36
+msgid "Where the doctrine should be located"
+msgstr ""
+
+#: corphandouts/models.py:74
+msgid "Amount of fits expected in the corp hangar. Set to 0 to ignore this fit"
+msgstr ""
+
+#: corphandouts/models.py:82
+msgid "Optional regex to get ships from"
+msgstr ""
+
+#: corphandouts/models.py:122
+msgid "Cargo"
+msgstr ""
+
+#: corphandouts/models.py:124
+msgid "Fitting"
+msgstr ""
+
+#: corphandouts/models.py:126
+msgid "Unknown"
+msgstr ""
+
+#: corphandouts/models.py:136
+msgid "Amount to remove/add to the fit to match the template"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/doctrine.html:12
+#: corphandouts/templates/corphandouts/doctrine.html:62
+msgid "Ship Type"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/doctrine.html:13
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:6
+msgid "Ship name"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/doctrine.html:14
+#: corphandouts/templates/corphandouts/index.html:17
+msgid "Errors"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/index.html:13
+msgid "Name"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/index.html:15
+msgid "Corporation<br>Division"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/index.html:18
+msgid "Ships"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/modals/content_base.html:26
+msgid "Close"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:16
+msgid "Ship type"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:26
+msgid "Type name"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:27
+msgid "Amount to change"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:28
+#: corphandouts/templates/corphandouts/partials/fit_corrections.html:50
+msgid "Location"
+msgstr ""
+
+#: corphandouts/templates/corphandouts/partials/nav_collapse_left.html:5
+msgid "View all handout reports"
+msgstr ""

aa_corphandouts-0.1.0/corphandouts/management/commands/testing.py

@@ -0,0 +1,9 @@
+from django.core.management.base import BaseCommand
+
+from corphandouts.tasks import update_doctrine_report
+
+
+class Command(BaseCommand):
+
+    def handle(self, *args, **options):
+        update_doctrine_report(1)