aa-metenox 0.1.0__tar.gz

aa_metenox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Erik Kalkoken
+
+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_metenox-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.1
+Name: aa-metenox
+Version: 0.1.0
+Summary: Metenox app config
+Author-email: T'rahk Rokym <trahk.rokym@gmail.com>
+Requires-Python: >=3.8
+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: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Dist: allianceauth>=4
+Requires-Dist: aa-moonmining>=1.11
+Requires-Dist: allianceauth-app-utils>=1.25.0
+Requires-Dist: django-datatables-view>=1.20.0
+Project-URL: Changelog, https://gitlab.com/r0kym/aa-metenox/-/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://gitlab.com/r0kym/aa-metenox
+Project-URL: Source, https://gitlab.com/r0kym/aa-metenox
+Project-URL: Tracker, https://gitlab.com/r0kym/aa-metenox/-/issues
+
+# Metenox
+
+AA module for Metenox management.
+
+## Feature roadmap:
+- [x] Estimate the value of moons by importing the [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining) database
+  - [ ] Displays the exact hourly pull of the moon
+- [x] Import Metenoxes from a corp
+  - [ ] Estimate corp monthly revenue
+  - [ ] Notifications when low reagent/fuel
+- [ ] Manager overview of corporations
+  - [ ] Taxation?
+
+### What this app won't do:
+- Estimate moon price for athanor.
+  Use [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining)
+- Ping when metenox are being reffed
+  Use [aa-structures](https://gitlab.com/ErikKalkoken/aa-structures)
+
+This module aims to be specific for Metenox management.
+
+## Installation
+
+### Step 1 - Check prerequisites
+
+1. Metenox 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. Metenox requires the Alliance Auth module [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining) to function.
+  The moon database and other utilities is imported from this module.
+
+### 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-metenox
+```
+
+### Step 3 - Configure Auth settings
+
+Configure your Auth settings (`local.py`) as follows:
+
+- Add `'metenox'` to `INSTALLED_APPS`
+- Add below lines to your settings file:
+
+```python
+CELERYBEAT_SCHEDULE['metenox_update_moon_prices'] = {
+    'task': 'metenox.tasks.update_moon_prices',
+    'schedule': crontab(hour='*/1'),
+}
+CELERYBEAT_SCHEDULE['metenox_update_moons_from_moonminin'] = {
+    'task': 'metenox.tasks.update_moons_from_moonmining',
+    'schedule': crontab(minutes='*/5'),
+}
+```
+
+Optional: Alter the application settings.
+The list can be found in [Settings](#settings)
+
+### 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.
+
+### Setp 5 - Load Goo from ESI
+
+Run the following management command to load all moon goos from ESI.
+This only has to be ran once.
+
+```bash
+python manage.py metenox_load_eve
+```
+
+Wait until the command is finished before continuing.
+
+### Step 5 - Load data
+
+First load the data from the moonmining module using
+```bash
+python manage.py metenox_update_moons_from_moonminin
+```
+
+Once it's done update their prices with
+
+```bash
+python manage.py metenox_update_all_prices
+```
+
+## Settings
+
+List of settings that can be modified for the application.
+You can alter them by adding them in your `local.py` file.
+
+| Name                                 | Descroption                                                                                      | Default |
+|--------------------------------------|--------------------------------------------------------------------------------------------------|---------|
+| 'METENOX_ADMIN_NOTIFICATIONS_ENABLE' | Whether admins will get notifications about important events like when someone adds a new owner. | True    |
+|                                      |                                                                                                  |         |
+
+
+## Dev notes
+
+Load eveuniverse using
+```shell
+python manage.py eveuniverse_load_types --category_id_with_dogma 25 metenox
+```
+
+Generate `eveuniverse.json`
+```shell
+python ../myauth/manage.py test metenox.tests.testdata.create_eveuniverse --keepdb -v 2
+```
+

aa_metenox-0.1.0/README.md

@@ -0,0 +1,116 @@
+# Metenox
+
+AA module for Metenox management.
+
+## Feature roadmap:
+- [x] Estimate the value of moons by importing the [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining) database
+  - [ ] Displays the exact hourly pull of the moon
+- [x] Import Metenoxes from a corp
+  - [ ] Estimate corp monthly revenue
+  - [ ] Notifications when low reagent/fuel
+- [ ] Manager overview of corporations
+  - [ ] Taxation?
+
+### What this app won't do:
+- Estimate moon price for athanor.
+  Use [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining)
+- Ping when metenox are being reffed
+  Use [aa-structures](https://gitlab.com/ErikKalkoken/aa-structures)
+
+This module aims to be specific for Metenox management.
+
+## Installation
+
+### Step 1 - Check prerequisites
+
+1. Metenox 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. Metenox requires the Alliance Auth module [aa-moonmining](https://gitlab.com/ErikKalkoken/aa-moonmining) to function.
+  The moon database and other utilities is imported from this module.
+
+### 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-metenox
+```
+
+### Step 3 - Configure Auth settings
+
+Configure your Auth settings (`local.py`) as follows:
+
+- Add `'metenox'` to `INSTALLED_APPS`
+- Add below lines to your settings file:
+
+```python
+CELERYBEAT_SCHEDULE['metenox_update_moon_prices'] = {
+    'task': 'metenox.tasks.update_moon_prices',
+    'schedule': crontab(hour='*/1'),
+}
+CELERYBEAT_SCHEDULE['metenox_update_moons_from_moonminin'] = {
+    'task': 'metenox.tasks.update_moons_from_moonmining',
+    'schedule': crontab(minutes='*/5'),
+}
+```
+
+Optional: Alter the application settings.
+The list can be found in [Settings](#settings)
+
+### 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.
+
+### Setp 5 - Load Goo from ESI
+
+Run the following management command to load all moon goos from ESI.
+This only has to be ran once.
+
+```bash
+python manage.py metenox_load_eve
+```
+
+Wait until the command is finished before continuing.
+
+### Step 5 - Load data
+
+First load the data from the moonmining module using
+```bash
+python manage.py metenox_update_moons_from_moonminin
+```
+
+Once it's done update their prices with
+
+```bash
+python manage.py metenox_update_all_prices
+```
+
+## Settings
+
+List of settings that can be modified for the application.
+You can alter them by adding them in your `local.py` file.
+
+| Name                                 | Descroption                                                                                      | Default |
+|--------------------------------------|--------------------------------------------------------------------------------------------------|---------|
+| 'METENOX_ADMIN_NOTIFICATIONS_ENABLE' | Whether admins will get notifications about important events like when someone adds a new owner. | True    |
+|                                      |                                                                                                  |         |
+
+
+## Dev notes
+
+Load eveuniverse using
+```shell
+python manage.py eveuniverse_load_types --category_id_with_dogma 25 metenox
+```
+
+Generate `eveuniverse.json`
+```shell
+python ../myauth/manage.py test metenox.tests.testdata.create_eveuniverse --keepdb -v 2
+```

aa_metenox-0.1.0/metenox/__init__.py

@@ -0,0 +1,6 @@
+"""Metenox app config"""
+
+# pylint: disable = invalid-name
+default_app_config = "metenox.apps.MetenoxConfig"
+
+__version__ = "0.1.0"

aa_metenox-0.1.0/metenox/admin.py

@@ -0,0 +1,5 @@
+"""Admin site."""
+
+# from django.contrib import admin
+
+# Register your models for the admin site here.

aa_metenox-0.1.0/metenox/api/fuzzwork.py

@@ -0,0 +1,71 @@
+"""Interactions with the fuzzwork market API"""
+
+from enum import Enum
+from typing import Dict, List
+
+import requests
+
+from eveuniverse.models import EveType
+
+from allianceauth.services.hooks import get_extension_logger
+
+FUZZWORK_URL = "https://market.fuzzwork.co.uk/aggregates/"
+THE_FORGE_REGION_ID = 10000002
+
+logger = get_extension_logger(__name__)
+
+
+class BuySell(Enum):
+    """Parameter to see if you want to fetch buy or sell orders"""
+
+    BUY = "buy"
+    SELL = "sell"
+
+
+class PriceType(Enum):
+    """Parameter to know what price aggregate you're looking for"""
+
+    WEIGHTED_AVERAGE = "weightedAverage"
+    MAX = "max"
+    MIN = "min"
+    MEDIAN = "median"
+    FIVE_PERCENT_WEIGHTED_AVERAGE = "percentile"
+
+
+def get_types_prices(
+    eve_types: List[EveType], buy_sell: BuySell, price_type: PriceType
+) -> Dict[int, float]:
+    """
+    Retrieves the price of the given eve_types from the Fuzzwork API
+    The parameters allow to select the  price type you want
+    """
+
+    type_ids = [eve_type.id for eve_type in eve_types]
+    return get_type_ids_prices(type_ids, buy_sell, price_type)
+
+
+def get_type_ids_prices(
+    eve_types_ids: List[int],
+    buy_sell: BuySell = BuySell.BUY,
+    price_type: PriceType = PriceType.FIVE_PERCENT_WEIGHTED_AVERAGE,
+) -> Dict[int, float]:
+    """
+    Retrieves the price of the given eve_type_ids from the Fuzzwork API
+    The parameters allow to select the  price type you want
+    """
+
+    if not eve_types_ids:
+        logger.warning("Received an empty list for fetching prices")
+
+    url = f"{FUZZWORK_URL}?region={THE_FORGE_REGION_ID}&types={','.join([str(eve_type_id) for eve_type_id in eve_types_ids])}"
+
+    logger.info("Trying to fetch data from %s" % url)
+    r = requests.get(url, timeout=5)
+    r.raise_for_status()
+
+    output_dic = {}
+
+    for type_id, market_info in r.json().items():
+        output_dic[type_id] = market_info[buy_sell.value][price_type.value]
+
+    return output_dic

aa_metenox-0.1.0/metenox/app_settings.py

@@ -0,0 +1,10 @@
+"""App settings."""
+
+from app_utils.app_settings import clean_setting
+
+METENOX_ADMIN_NOTIFICATIONS_ENABLED = clean_setting(
+    "METENOX_ADMIN_NOTIFICATION_ENABLED", True
+)
+"""Whether admins will get notifications about important events like
+when someone adds a new owner.
+"""

aa_metenox-0.1.0/metenox/apps.py

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

aa_metenox-0.1.0/metenox/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 MetenoxMenuItem(MenuItemHook):
+    """This class ensures only authorized users will see the menu entry"""
+
+    def __init__(self):
+        # setup menu entry for sidebar
+        MenuItemHook.__init__(
+            self,
+            _("metenox"),
+            "fas fa-oil-well fa-fw",
+            "metenox:index",
+            navactive=["metenox:"],
+        )
+
+    def render(self, request):
+        if request.user.has_perm("metenox.basic_access"):
+            return MenuItemHook.render(self, request)
+        return ""
+
+
+@hooks.register("menu_item_hook")
+def register_menu():
+    return MetenoxMenuItem()
+
+
+@hooks.register("url_hook")
+def register_urls():
+    return UrlHook(urls, "metenox", r"^metenox/")

aa_metenox-0.1.0/metenox/esi.py

@@ -0,0 +1,67 @@
+"""
+Modules containing all ESI interactions
+"""
+
+from typing import Optional
+
+from esi.clients import EsiClientProvider
+from esi.errors import TokenError
+
+from metenox.models import HoldingCorporation
+
+from . import __version__
+
+METENOX_TYPE_ID = 81826
+
+
+esi = EsiClientProvider(app_info_text=f"aa-metenox v{__version__}")
+
+
+def get_metenox_from_esi(
+    holding_corporation: HoldingCorporation,
+) -> Optional[list[dict]]:
+    """Returns all metenoxes associated with a given Owner"""
+
+    structures = get_structures_from_esi(holding_corporation)
+
+    return (
+        [
+            structure
+            for structure in structures
+            if structure["type_id"] == METENOX_TYPE_ID
+        ]
+        if structures
+        else None
+    )
+
+
+def get_structure_info_from_esi(
+    holding_corporation: HoldingCorporation, structure_id: int
+) -> dict:
+    """Returns the location information of a structure"""
+
+    for owner in holding_corporation.owners.all():
+
+        structure_info = esi.client.Universe.get_universe_structures_structure_id(
+            structure_id=structure_id,
+            token=owner.fetch_token().valid_access_token(),
+        ).result()
+
+        return structure_info
+
+
+def get_structures_from_esi(
+    holding_corporation: HoldingCorporation,
+) -> Optional[list[dict]]:
+    """Returns all structures associated with a given owner"""
+
+    for owner in holding_corporation.owners.all():
+        try:
+            return esi.client.Corporation.get_corporations_corporation_id_structures(
+                corporation_id=owner.corporation.corporation.corporation_id,
+                token=owner.fetch_token().valid_access_token(),
+            ).results()
+        except TokenError:  # tries the next owner
+            continue
+
+    return None  # No owner worked

aa_metenox-0.1.0/metenox/management/commands/metenox_load_eve.py

@@ -0,0 +1,34 @@
+from django.core.management import BaseCommand
+from eveuniverse.models import EveType
+from eveuniverse.tasks import update_or_create_eve_object
+
+from allianceauth.services.hooks import get_extension_logger
+
+logger = get_extension_logger(__name__)
+
+
+class Command(BaseCommand):
+    help = "Preload static data from the ESI"
+
+    def handle(self, *args, **options):
+        self.stdout.write("Loading data from the ESI. It might take a while")
+        goo_types_count = EveType.objects.filter(eve_group_id=25).count()
+        self.stdout.write(f"Already {goo_types_count} in the database.")
+        self.stdout.write()
+        user_input = input("Do you want to proceed? (y/N)?")
+
+        if user_input.lower() == "y":
+            self.stdout.write("Starting to fetch moon goos")
+            update_or_create_eve_object.delay(
+                model_name="EveType",
+                id=25,
+                enabled_sections=[
+                    EveType.Section.DOGMAS,
+                    EveType.Section.TYPE_MATERIALS,
+                ],
+            )
+
+            self.stdout.write("Done")
+
+        else:
+            self.stdout.write("Aborted")

aa_metenox-0.1.0/metenox/management/commands/metenox_update_all_owners.py

@@ -0,0 +1,18 @@
+from django.core.management.base import BaseCommand
+
+from allianceauth.services.hooks import get_extension_logger
+
+from metenox import tasks
+from metenox.models import HoldingCorporation
+
+logger = get_extension_logger(__name__)
+
+
+class Command(BaseCommand):
+    help = "Checks all metenox owners and update their Metenoxes"
+
+    def handle(self, *args, **options):
+        holding_corps = HoldingCorporation.objects.all()
+        logger.info(f"Starting update for {len(holding_corps)} owner(s)")
+        for holding in holding_corps:
+            tasks.update_holding.delay(holding.corporation.corporation_id)

aa_metenox-0.1.0/metenox/management/commands/metenox_update_all_prices.py

@@ -0,0 +1,15 @@
+from django.core.management.base import BaseCommand
+
+from allianceauth.services.hooks import get_extension_logger
+
+from metenox import tasks
+
+logger = get_extension_logger(__name__)
+
+
+class Command(BaseCommand):
+    help = "Fetches new moon goo prices and update metenox harvest values"
+
+    def handle(self, *args, **options):
+        logger.info("Command to update prices received")
+        tasks.update_moon_prices.delay()

aa_metenox-0.1.0/metenox/management/commands/metenox_update_moons_from_moonmining.py

@@ -0,0 +1,16 @@
+from django.core.management.base import BaseCommand
+
+from allianceauth.services.hooks import get_extension_logger
+
+from metenox import tasks
+
+logger = get_extension_logger(__name__)
+
+
+class Command(BaseCommand):
+    help = (
+        "Fetches all moons from moonining application and adds them to this application"
+    )
+
+    def handle(self, *args, **options):
+        tasks.update_moons_from_moonmining.delay()