aa-planetary-operations 0.1.0__py3-none-any.whl

aa_planetary_operations-0.1.0.dist-info/METADATA

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: aa-planetary-operations
+Version: 0.1.0
+Summary: Multi-character planetary industry planning for Alliance Auth v5
+Author: jaybone26
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jaybone26/aa-planetary-operations
+Project-URL: Documentation, https://github.com/jaybone26/aa-planetary-operations#readme
+Project-URL: Repository, https://github.com/jaybone26/aa-planetary-operations
+Project-URL: Issues, https://github.com/jaybone26/aa-planetary-operations/issues
+Keywords: allianceauth,eve-online,planetary-industry
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE.md
+Requires-Dist: allianceauth<6,>=5.0
+Requires-Dist: requests<3,>=2.32
+Requires-Dist: ortools<10,>=9.10
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: pytest-django>=4.8; extra == "test"
+Requires-Dist: requests-mock>=1.12; extra == "test"
+Requires-Dist: fakeredis>=2; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: build; extra == "test"
+Dynamic: license-file
+
+![Version](https://img.shields.io/badge/version-0.1.0-blue)
+![Alliance Auth](https://img.shields.io/badge/Alliance_Auth-v5-blue)
+![Python](https://img.shields.io/badge/Python-3.11%2B-blue)
+![Django](https://img.shields.io/badge/Django-5.2-green)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/LICENSE)
+[![Verification](https://img.shields.io/badge/local_tests-36_passed-brightgreen)](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/VERIFICATION.md)
+![Status](https://img.shields.io/badge/status-staging-orange)
+
+# AA Planetary Operations for Alliance Auth
+
+Plan your planetary industry across your main and alts, build the production network, and see its Jita buy value per pull.
+
+---
+
+## Contents
+
+- [Features](#features)
+- [Upcoming](#upcoming)
+- [Highlights](#highlights)
+- [Installation](#installation)
+  - [Step 1 — Install the package](#step-1--install-the-package)
+  - [Step 2 — Configure Alliance Auth](#step-2--configure-alliance-auth)
+  - [Step 3 — Configure ESI access](#step-3--configure-esi-access)
+  - [Step 4 — Run migrations and collect static files](#step-4--run-migrations-and-collect-static-files)
+  - [Step 5 — Set up permissions](#step-5--set-up-permissions)
+  - [Step 6 — Authorize characters and build a plan](#step-6--authorize-characters-and-build-a-plan)
+- [Settings](#settings)
+- [Using the planner](#using-the-planner)
+- [Translations](#translations)
+- [Contributing](#contributing)
+- [License and credits](#license-and-credits)
+
+## Features
+
+- **Main and alt planning** — combine up to ten AA-authenticated characters in one operation.
+- **Automatic PI skill reads** — use active skill levels and existing colonies to determine available capacity.
+- **P0 through P4** — choose any of the 83 PI commodities as your finished product.
+- **Import tiers** — extract from P0 or start with supplied P1, P2, or P3 materials.
+- **Region selection** — use real planet types, resources, recipes, and stargate connections from CCP's static data.
+- **One system first** — try single-system layouts before expanding into nearby systems.
+- **Character assignments** — fit colonies and facilities within each character's skill limits.
+- **Build sheets** — see each planet, command-center level, extractor, processor, and required material.
+- **Logistics plans** — get import quantities, local routes, character handoffs, hauling volumes, and regional gate paths.
+- **Extraction schedules** — set the pull duration, output target, assumed extraction yield, and extractor head count.
+- **Jita buy valuation** — estimate gross ISK per pull, day, and week from Jita 4-4 buy orders and available order volume.
+- **Saved operations** — keep private plans, adjust a copy, refresh prices, or export the build sheet.
+
+## Upcoming
+
+Future possibilities beyond V1:
+
+- Discord alerts.
+- Alliance-wide collaborative production and suppliers.
+- Advanced POCO tools.
+- Historical production and market analytics.
+
+## Highlights
+
+### Characters and operation planner
+
+Select your authenticated characters and configure the production chain in one place.
+
+![AA Planetary Operations — characters and planner](https://raw.githubusercontent.com/jaybone26/aa-planetary-operations/HEAD/docs/images/planner.png)
+
+### Production overview
+
+Review estimated output, deployment size, and the Jita valuation status for a saved operation.
+
+![AA Planetary Operations — saved operation overview](https://raw.githubusercontent.com/jaybone26/aa-planetary-operations/HEAD/docs/images/operation.png)
+
+*Screenshots show a local demonstration using sample characters. Market pricing is unavailable in the pictured preview; the live public ESI check is recorded in [Verification](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/VERIFICATION.md).*
+
+## Installation
+
+> **Requirements:** Alliance Auth v5, Python 3.11+, and your existing Auth database, Redis/Valkey, and Celery worker.
+>
+> Version 0.1.0 is ready for staging evaluation. Install it directly into your Alliance Auth virtual environment. Complete a real SSO authorization and worker run on your server before rollout.
+
+### Step 1 — Install the package
+
+Activate the virtual environment used by your Alliance Auth installation, then install the supplied wheel:
+
+```shell
+python -m pip install /path/to/aa_planetary_operations-0.1.0-py3-none-any.whl
+```
+
+Alternatively, install from the source directory:
+
+```shell
+python -m pip install /path/to/aa-planetary-operations
+```
+
+PyPI publication is pending. Maintainers can follow the [Publishing guide](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/docs/PUBLISHING.md) to configure the first release.
+
+### Step 2 — Configure Alliance Auth
+
+Add the app in your Auth project's `settings/local.py`:
+
+```python
+INSTALLED_APPS += [
+    "planetary_operations",
+]
+```
+
+Set a User-Agent that identifies your deployment and administrator contact:
+
+```python
+PLANETARY_OPERATIONS_USER_AGENT = "AA-Planetary-Operations/0.1.0 (your administrator contact)"
+PLANETARY_OPERATIONS_SEARCH_SECONDS = 30
+```
+
+The package includes its PI and universe catalog. A separate SDE app or initial data download is not required.
+
+### Step 3 — Configure ESI access
+
+Enable the following scopes on the EVE developer application used by your Auth installation:
+
+| Scope | Purpose |
+| :--- | :--- |
+| `esi-skills.read_skills.v1` | Read each character's active PI skill levels. |
+| `esi-planets.manage_planets.v1` | Read existing colonies and occupied planet IDs. |
+
+Keep your existing AA SSO callback URL. Users grant these scopes through **Authorize a character’s PI access**. The plugin only reads ESI, including the scope named “manage”; it makes no in-game changes.
+
+### Step 4 — Run migrations and collect static files
+
+From your Auth project directory:
+
+```shell
+python manage.py migrate
+python manage.py collectstatic --noinput
+python manage.py check
+```
+
+Restart your existing Auth web processes and Celery workers through your normal service manager.
+
+Plan calculations use the task `planetary_operations.tasks.calculate_plan` on the existing AA worker. No additional Celery Beat schedule is required.
+
+### Step 5 — Set up permissions
+
+Grant this permission to the appropriate AA group or state:
+
+| Permission | Description | Access |
+| :--- | :--- | :--- |
+| `planetary_operations.basic_access` | Can use Planetary Operations | Opens the app and allows users to create and manage their own plans. |
+
+The sidebar entry appears for permitted users. Saved plans are private to their owner.
+
+### Step 6 — Authorize characters and build a plan
+
+1. Open **Planetary Operations** from the AA sidebar.
+2. Attach any missing alts to your AA account.
+3. Use **Authorize a character’s PI access** for each character.
+4. Select the characters, finished product, import tier, and region.
+5. Set the pull duration and output target. Enter an extraction estimate based on your in-game program.
+6. Select **Build & save plan**. The result page updates when the worker finishes.
+
+## Settings
+
+Optional settings in `settings/local.py`:
+
+| Setting | Description | Default |
+| :--- | :--- | :--- |
+| `PLANETARY_OPERATIONS_USER_AGENT` | Identifies your application to ESI. Set it to include your administrator contact. | `AA-Planetary-Operations/0.1.0` |
+| `PLANETARY_OPERATIONS_SEARCH_SECONDS` | Solver search budget in seconds, limited to 5–120. | `30` |
+
+## Using the planner
+
+Existing colonies reduce available slots by default. Enable **Plan a replacement for my existing colonies** if you intend to rebuild them in game. Saved plans are alternative layouts; they do not reserve colony slots against each other.
+
+**Read estimates as steady-state targets.** The planner checks factory cycles and fitting budgets against your requested output. Future extraction yield, resource hotspots, exact link placement, startup buffers, sovereignty, and POCO access need an in-game check. Nearby-system results report a feasible network without claiming a global regional optimum.
+
+**Jita estimates are gross value.** Imported materials, taxes, fees, and hauling costs are excluded. Unfilled buy-order volume is reported. Day/week figures extrapolate the current pull valuation; future liquidity can change.
+
+For the full assumptions, operating instructions, catalog updates, and troubleshooting, see the [Operating guide](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/docs/OPERATING_GUIDE.md).
+
+## Translations
+
+The V1 interface is currently in English. Translation support is not included in this release.
+
+## Contributing
+
+Development uses a standard Python virtual environment. See the [Development guide](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/docs/DEVELOPMENT.md) for setup and verification commands.
+
+- [Architecture](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/ARCHITECTURE.md) — modules, planning constraints, and ownership checks.
+- [Verification](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/VERIFICATION.md) — completed tests, AA version checks, and live-data results.
+- [Operating guide](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/docs/OPERATING_GUIDE.md) — behavior to preserve when changing the planner.
+
+Include relevant tests with changes to production calculations, character permissions, or market handling.
+
+## License and credits
+
+Source code is available under the [MIT License](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/LICENSE).
+
+Built for [Alliance Auth](https://allianceauth.readthedocs.io/) using [Django-ESI](https://django-esi.readthedocs.io/) token management, CCP's [Static Data Export](https://developers.eveonline.com/docs/services/static-data/), and the [EVE ESI API](https://esi.evetech.net/ui/).
+
+EVE Online and its game data belong to CCP. See [NOTICE.md](https://github.com/jaybone26/aa-planetary-operations/blob/HEAD/NOTICE.md).

aa_planetary_operations-0.1.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+aa_planetary_operations-0.1.0.dist-info/licenses/LICENSE,sha256=x9FiUns2NmZSPwSJEvAg0Pflcj_lcBRp3lkkUG6Q-zA,1093
+aa_planetary_operations-0.1.0.dist-info/licenses/NOTICE.md,sha256=DXaCsPTWoMCavmEtDeiATpbmJHSEFKhxtnlgci_VqLM,638
+planetary_operations/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+planetary_operations/apps.py,sha256=TJuIEaKafSZVFDg8M9H8BIGwQYztuHrdvjEb23_i29w,213
+planetary_operations/auth_hooks.py,sha256=KyxQ6c7nY5n3LmUNW1GHoFlD_3JBsxo0jbn8fQYNczo,709
+planetary_operations/catalog.py,sha256=KFvKiPqftuDf2mHTtBqGPD7iR8qI5QGo21t04_8pD0k,391
+planetary_operations/characters.py,sha256=-c8ZHu0R9GKQ1OslNeisUlrRynhw8mBrcMRE87NXEWM,3132
+planetary_operations/esi.py,sha256=nPPc0fiGFvVsc1zt9MWhUo9LN4jqRBgQdL8uMzUUvbQ,2132
+planetary_operations/forms.py,sha256=qiZiF3m4rLAu8K9ktkafKYy6lbNrd4Nsn7A3gqg7bKA,4030
+planetary_operations/market.py,sha256=qzQUr4waDGrAiiwlGgtuNnD5Kf4LgNzQE5RsXhPBuU4,3873
+planetary_operations/models.py,sha256=m30SMOwqdGeKBUklio_G939pRqYkdxC57v1FONOH01o,1534
+planetary_operations/planner.py,sha256=IhBZ7pZaH9r9_uJtOmmRUc1zQ2LbVT7xnMLl_RgDROo,20483
+planetary_operations/tasks.py,sha256=u7_L6ryW_4yqUDNaHEe-iKLaQH07zBdd55okzmfkL9E,2681
+planetary_operations/urls.py,sha256=exJIP84_uVpFT8G8ZVBdYoCQMGtScvtmDl46qsR5uwQ,604
+planetary_operations/views.py,sha256=zpkVSf_qdE45tiD6Xgz5DkyiPM4uOJ-Bx2K7abceQrY,7249
+planetary_operations/data/catalog.json,sha256=XRHGRHZP4foZ3ZSWJCghkmKbUiTN6FY4GCcYAv2fBAA,4823890
+planetary_operations/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+planetary_operations/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+planetary_operations/management/commands/po_recover_plans.py,sha256=D3_yaBSrHz_J8bpzDST_sVdoxtwZq_CkTodDxdSI62g,852
+planetary_operations/migrations/0001_initial.py,sha256=-0fDooAv0R8InZiNWo1-MRXVfHrrfNj3_VBNb6iSweI,3094
+planetary_operations/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+planetary_operations/static/planetary_operations/app.css,sha256=4moa6CRH95qdQEDfJRobs1ZVGAgPYbLdPhhBfFHWIr4,1282
+planetary_operations/static/planetary_operations/progress.js,sha256=S1fhj_v4B88PfhBPRFmTHkZyjwYH1f2bqOxB62d2Heg,750
+planetary_operations/templates/planetary_operations/base.html,sha256=LyxQUT5cQ0i5jMUS9ZwJ1Aby1WVRrSDHQ0BaI-uJ0hs,659
+planetary_operations/templates/planetary_operations/detail.html,sha256=P1LC-CWcwfdwDc6N4wLeuLOG_Ra4CNMNaYq0uO9Zs7U,6718
+planetary_operations/templates/planetary_operations/index.html,sha256=KXGLJgrBwAR4boeC6E2mAxxB2Z19CQYPkwmg3gVX7vg,3055
+aa_planetary_operations-0.1.0.dist-info/METADATA,sha256=or0DZOVBTF4la3gj_0BjZwAafN-rWDDFKWSY2CXOTg0,11090
+aa_planetary_operations-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+aa_planetary_operations-0.1.0.dist-info/top_level.txt,sha256=lgt0xnd3Dcoys8jlcW5XJx805Duzrm3RilhWSMDDwfg,21
+aa_planetary_operations-0.1.0.dist-info/RECORD,,

aa_planetary_operations-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aa_planetary_operations-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AA Planetary Operations 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_planetary_operations-0.1.0.dist-info/licenses/NOTICE.md

@@ -0,0 +1,7 @@
+# Game-data notice
+
+EVE Online, the EVE logo, and EVE game data are the intellectual property of CCP hf. This community application is not affiliated with or endorsed by CCP or the Alliance Auth project.
+
+The bundled catalog is derived from the official EVE Online Static Data Export. Access and use of EVE APIs and static data remain subject to CCP's applicable developer terms. No license to CCP's trademarks or game data is granted by this application's source-code license.
+
+The dependency packages retain their own licenses. Alliance Auth is GPL-licensed; review its distribution requirements when distributing combined deployments.

aa_planetary_operations-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+planetary_operations

planetary_operations/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

planetary_operations/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class PlanetaryOperationsConfig(AppConfig):
+    name = "planetary_operations"
+    verbose_name = "Planetary Operations"
+    default_auto_field = "django.db.models.BigAutoField"

planetary_operations/auth_hooks.py

@@ -0,0 +1,27 @@
+from allianceauth import hooks
+from allianceauth.menu.hooks import MenuItemHook
+from allianceauth.services.hooks import UrlHook
+
+from . import urls
+
+
+class PlanetaryMenu(MenuItemHook):
+    def __init__(self):
+        super().__init__(
+            "Planetary Operations", "fa-solid fa-globe", "planetary_operations:index", order=1500
+        )
+
+    def render(self, request):
+        if request.user.has_perm("planetary_operations.basic_access"):
+            return super().render(request)
+        return ""
+
+
+@hooks.register("menu_item_hook")
+def menu_item():
+    return PlanetaryMenu()
+
+
+@hooks.register("url_hook")
+def url_hook():
+    return UrlHook(urls, "planetary_operations", r"^planetary-operations/")

planetary_operations/catalog.py

@@ -0,0 +1,16 @@
+"""Read-only, process-local static data. Never stores user or token data."""
+
+import json
+from functools import lru_cache
+from importlib.resources import files
+
+
+@lru_cache(maxsize=1)
+def catalog():
+    return json.loads(
+        files("planetary_operations").joinpath("data/catalog.json").read_text("utf-8")
+    )
+
+
+def commodity(type_id):
+    return catalog()["commodities"][str(type_id)]

planetary_operations/characters.py

@@ -0,0 +1,79 @@
+"""AA ownership and scoped-token checks precede every private ESI read."""
+
+from allianceauth.authentication.models import CharacterOwnership
+from esi.models import Token
+
+from . import esi
+from .models import CharacterSnapshot
+from .planner import Character, PlanningError
+
+SCOPES = ["esi-skills.read_skills.v1", "esi-planets.manage_planets.v1"]
+PI_SKILLS = {
+    2495: "interplanetary_consolidation",
+    2505: "command_center_upgrades",
+    2403: "planetology",
+    2406: "advanced_planetology",
+    13279: "remote_sensing",
+}
+
+
+def owned_characters(user):
+    return CharacterOwnership.objects.filter(user=user).select_related("character")
+
+
+def refresh_character(user, character_id):
+    try:
+        ownership = owned_characters(user).get(character__character_id=character_id)
+    except CharacterOwnership.DoesNotExist as exc:
+        raise PlanningError("That character is not attached to your AA account.") from exc
+    token = (
+        Token.objects.filter(
+            user=user, character_id=character_id, character_owner_hash=ownership.owner_hash
+        )
+        .require_scopes(SCOPES)
+        .first()
+    )
+    if not token:
+        raise PlanningError(f"Authorize PI access for {ownership.character.character_name}.")
+    try:
+        access = token.valid_access_token()
+    except Exception as exc:
+        raise PlanningError(
+            f"Reauthorize PI access for {ownership.character.character_name}."
+        ) from exc
+    data, _ = esi.get(f"characters/{character_id}/skills/", access_token=access)
+    colonies, _ = esi.get(f"characters/{character_id}/planets/", access_token=access)
+    try:
+        # Active levels respect current account/skill restrictions.
+        skills = {
+            str(row["skill_id"]): row["active_skill_level"]
+            for row in data["skills"]
+            if row["skill_id"] in PI_SKILLS
+        }
+        if any(not isinstance(v, int) or not 0 <= v <= 5 for v in skills.values()):
+            raise ValueError("Invalid skill level")
+        planet_ids = [int(row["planet_id"]) for row in colonies]
+    except (KeyError, TypeError, ValueError) as exc:
+        raise esi.ESIUnavailable("ESI returned incomplete character data.") from exc
+    # Recheck ownership after network calls, including transfers between users.
+    if not CharacterOwnership.objects.filter(
+        pk=ownership.pk, user=user, owner_hash=ownership.owner_hash
+    ).exists():
+        raise PlanningError("Character ownership changed during the refresh.")
+    snapshot, _ = CharacterSnapshot.objects.update_or_create(
+        ownership=ownership,
+        defaults=dict(owner_hash=ownership.owner_hash, skills=skills, colonies=planet_ids),
+    )
+    return snapshot
+
+
+def planning_character(snapshot, replace_existing=False):
+    character = snapshot.ownership.character
+    return Character(
+        id=character.character_id,
+        name=character.character_name,
+        ic=snapshot.skills.get("2495", 0),
+        ccu=snapshot.skills.get("2505", 0),
+        reserved=0 if replace_existing else len(snapshot.colonies),
+        occupied=() if replace_existing else tuple(snapshot.colonies),
+    )