aa-ledger 0.3.3__tar.gz

aa_ledger-0.3.3/.gitignore

@@ -0,0 +1,11 @@
+*.log
+.tox/
+*.old
+__pycache__
+node_modules/
+
+/build/
+/dist/
+.coverage
+.env
+.pypirc

aa_ledger-0.3.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Geuthur]
+
+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_ledger-0.3.3/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.3
+Name: aa-ledger
+Version: 0.3.3
+Dynamic: Summary
+Project-URL: Changelog, https://github.com/Geuthur/aa-ledger/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://github.com/Geuthur/aa-ledger
+Project-URL: Source, https://github.com/Geuthur/aa-ledger
+Project-URL: Tracker, https://github.com/Geuthur/aa-ledger/issues
+Author-email: Geuthur <devgeuthur@gmail.com>
+License: MIT License
+        
+        Copyright (c) [2024] [Geuthur]
+        
+        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.
+License-File: LICENSE
+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 :: Only
+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
+Requires-Python: >=3.8
+Requires-Dist: allianceauth-app-utils>=1.19
+Requires-Dist: allianceauth>=4
+Requires-Dist: dacite
+Requires-Dist: django-eveuniverse>=1.3
+Requires-Dist: django-ninja
+Provides-Extra: tests-allianceauth-latest
+Requires-Dist: coverage; extra == 'tests-allianceauth-latest'
+Requires-Dist: django-webtest; extra == 'tests-allianceauth-latest'
+Description-Content-Type: text/markdown
+
+# Ledger module for AllianceAuth.<a name="aa-ledger"></a>
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Geuthur/aa-ledger/master.svg)](https://results.pre-commit.ci/latest/github/Geuthur/aa-ledger/master)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Tests](https://github.com/Geuthur/aa-ledger/actions/workflows/autotester.yml/badge.svg)](https://github.com/Geuthur/aa-ledger/actions/workflows/autotester.yml)
+
+- [AA Ledger](#aa-ledger)
+  - [Features](#features)
+  - [Upcoming](#upcoming)
+  - [Installation](#features)
+    - [Step 1 - Install the Package](#step1)
+    - [Step 2 - Configure Alliance Auth](#step2)
+    - [Step 3 - Add the Scheduled Tasks](#step3)
+    - [Step 4 - Migration to AA](#step4)
+    - [Step 5 - Setting up Permissions](#step5)
+    - [Step 6 - (Optional) Setting up Compatibilies](#step6)
+  - [Highlights](#highlights)
+
+## Features<a name="features"></a>
+
+- Graphical Overview
+- Ratting,Mining,Trading
+- Character Ledger
+- Corporation Ledger
+
+## Upcoming<a name="upcoming"></a>
+
+- Corp Tax System (Tracks specific amount that transfer'd to specific division)
+- Events Calender
+
+## Installation<a name="installation"></a>
+
+### Step 1 - Install the Package<a name="step1"></a>
+
+Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.
+
+```shell
+pip install aa-ledger
+```
+
+### Step 2 - Configure Alliance Auth<a name="step2"></a>
+
+Configure your Alliance Auth settings (`local.py`) as follows:
+
+- Add `'allianceauth.corputils',` to `INSTALLED_APPS`
+- Add `'eveuniverse',` to `INSTALLED_APPS`
+- Add `'ledger',` to `INSTALLED_APPS`
+
+### Step 3 - Add the Scheduled Tasks<a name="step3"></a>
+
+To set up the Scheduled Tasks add following code to your `local.py`
+
+```python
+CELERYBEAT_SCHEDULE["ledger_character_audit_update_all"] = {
+    "task": "ledger.tasks.update_all_characters",
+    "schedule": crontab(hour="*/1"),
+}
+CELERYBEAT_SCHEDULE["ledger_corporation_audit_update_all"] = {
+    "task": "ledger.tasks.update_all_corps",
+    "schedule": crontab(hour="*/1"),
+}
+```
+
+### Step 4 - Migration to AA<a name="step4"></a>
+
+```shell
+python manage.py collectstatic
+python manage.py migrate
+```
+
+### Step 5 - Setting up Permissions<a name="step5"></a>
+
+With the Following IDs you can set up the permissions for the Ledger
+
+| ID                        | Description                            |                                                                                         |
+| :------------------------ | :------------------------------------- | :-------------------------------------------------------------------------------------- |
+| `basic_access`            | Can access the Ledger module           | All Members with the Permission can access the Ledger.                                  |
+| `moderator_access`        | Has access to moderation tools         | Not Implemented yet.                                                                    |
+| `admin_access`            | Has access to all Administration tools | Not Implemented yet.                                                                    |
+| `char_audit_admin_access` | Can Manage Character Audit Module      | Can Manage Character Audit Module, Like Add Memeberaudit Chars, View Character Journals |
+| `corp_audit_admin_access` | Can Manage Corporation Audit Module    | Can Manage Corporation Audit Module, Like Add Corp, View Corporation Journals           |
+
+### Step 6 - (Optional) Setting up Compatibilies<a name="step6"></a>
+
+The Following Settings can be setting up in the `local.py`
+
+- LEDGER_LOGGER_USE:        `True / False`
+- LEDGER_MEMBERAUDIT_USE:   `True / False`
+- LEDGER_CORPSTATS_TWO:     `True / False`
+
+If you set up LEDGER_LOGGER_USE to `True` you need to add the following code below:
+
+```python
+LOGGING_LEDGER = {
+    "handlers": {
+        "ledger_file": {
+            "level": "DEBUG",
+            "class": "logging.handlers.RotatingFileHandler",
+            "filename": os.path.join(BASE_DIR, "log/ledger.log"),
+            "formatter": "verbose",
+            "maxBytes": 1024 * 1024 * 5,
+            "backupCount": 5,
+        },
+    },
+    "loggers": {
+        "ledger": {
+            "handlers": ["ledger_file", "console"],
+            "level": "DEBUG",
+        },
+    },
+}
+LOGGING["handlers"].update(LOGGING_LEDGER["handlers"])
+LOGGING["loggers"].update(LOGGING_LEDGER["loggers"])
+```
+
+## Highlights<a name="highlights"></a>
+
+![Screenshot 2024-05-14 121014](https://github.com/Geuthur/aa-ledger/assets/761682/d0604260-b672-4bf5-a16a-d1b90557744d)
+
+![Screenshot 2024-05-14 121025](https://github.com/Geuthur/aa-ledger/assets/761682/f8f20e6a-d37d-4a50-a1aa-8615c0f8e88b)
+
+![Screenshot 2024-05-14 120944](https://github.com/Geuthur/aa-ledger/assets/761682/2d695369-1331-4be9-8adf-9c6dabf80dda)
+
+![Screenshot 2024-05-14 121001](https://github.com/Geuthur/aa-ledger/assets/761682/463b9921-150c-42c1-8c3e-eee0f5cfc2bb)
+
+> \[!NOTE\]
+> Contributing
+> You want to improve the project?
+> Just Make a [Pull Request](https://github.com/Geuthur/aa-ledger/pulls) with the Guidelines.
+> We Using pre-commit

aa_ledger-0.3.3/README.md

@@ -0,0 +1,130 @@
+# Ledger module for AllianceAuth.<a name="aa-ledger"></a>
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Geuthur/aa-ledger/master.svg)](https://results.pre-commit.ci/latest/github/Geuthur/aa-ledger/master)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Tests](https://github.com/Geuthur/aa-ledger/actions/workflows/autotester.yml/badge.svg)](https://github.com/Geuthur/aa-ledger/actions/workflows/autotester.yml)
+
+- [AA Ledger](#aa-ledger)
+  - [Features](#features)
+  - [Upcoming](#upcoming)
+  - [Installation](#features)
+    - [Step 1 - Install the Package](#step1)
+    - [Step 2 - Configure Alliance Auth](#step2)
+    - [Step 3 - Add the Scheduled Tasks](#step3)
+    - [Step 4 - Migration to AA](#step4)
+    - [Step 5 - Setting up Permissions](#step5)
+    - [Step 6 - (Optional) Setting up Compatibilies](#step6)
+  - [Highlights](#highlights)
+
+## Features<a name="features"></a>
+
+- Graphical Overview
+- Ratting,Mining,Trading
+- Character Ledger
+- Corporation Ledger
+
+## Upcoming<a name="upcoming"></a>
+
+- Corp Tax System (Tracks specific amount that transfer'd to specific division)
+- Events Calender
+
+## Installation<a name="installation"></a>
+
+### Step 1 - Install the Package<a name="step1"></a>
+
+Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.
+
+```shell
+pip install aa-ledger
+```
+
+### Step 2 - Configure Alliance Auth<a name="step2"></a>
+
+Configure your Alliance Auth settings (`local.py`) as follows:
+
+- Add `'allianceauth.corputils',` to `INSTALLED_APPS`
+- Add `'eveuniverse',` to `INSTALLED_APPS`
+- Add `'ledger',` to `INSTALLED_APPS`
+
+### Step 3 - Add the Scheduled Tasks<a name="step3"></a>
+
+To set up the Scheduled Tasks add following code to your `local.py`
+
+```python
+CELERYBEAT_SCHEDULE["ledger_character_audit_update_all"] = {
+    "task": "ledger.tasks.update_all_characters",
+    "schedule": crontab(hour="*/1"),
+}
+CELERYBEAT_SCHEDULE["ledger_corporation_audit_update_all"] = {
+    "task": "ledger.tasks.update_all_corps",
+    "schedule": crontab(hour="*/1"),
+}
+```
+
+### Step 4 - Migration to AA<a name="step4"></a>
+
+```shell
+python manage.py collectstatic
+python manage.py migrate
+```
+
+### Step 5 - Setting up Permissions<a name="step5"></a>
+
+With the Following IDs you can set up the permissions for the Ledger
+
+| ID                        | Description                            |                                                                                         |
+| :------------------------ | :------------------------------------- | :-------------------------------------------------------------------------------------- |
+| `basic_access`            | Can access the Ledger module           | All Members with the Permission can access the Ledger.                                  |
+| `moderator_access`        | Has access to moderation tools         | Not Implemented yet.                                                                    |
+| `admin_access`            | Has access to all Administration tools | Not Implemented yet.                                                                    |
+| `char_audit_admin_access` | Can Manage Character Audit Module      | Can Manage Character Audit Module, Like Add Memeberaudit Chars, View Character Journals |
+| `corp_audit_admin_access` | Can Manage Corporation Audit Module    | Can Manage Corporation Audit Module, Like Add Corp, View Corporation Journals           |
+
+### Step 6 - (Optional) Setting up Compatibilies<a name="step6"></a>
+
+The Following Settings can be setting up in the `local.py`
+
+- LEDGER_LOGGER_USE:        `True / False`
+- LEDGER_MEMBERAUDIT_USE:   `True / False`
+- LEDGER_CORPSTATS_TWO:     `True / False`
+
+If you set up LEDGER_LOGGER_USE to `True` you need to add the following code below:
+
+```python
+LOGGING_LEDGER = {
+    "handlers": {
+        "ledger_file": {
+            "level": "DEBUG",
+            "class": "logging.handlers.RotatingFileHandler",
+            "filename": os.path.join(BASE_DIR, "log/ledger.log"),
+            "formatter": "verbose",
+            "maxBytes": 1024 * 1024 * 5,
+            "backupCount": 5,
+        },
+    },
+    "loggers": {
+        "ledger": {
+            "handlers": ["ledger_file", "console"],
+            "level": "DEBUG",
+        },
+    },
+}
+LOGGING["handlers"].update(LOGGING_LEDGER["handlers"])
+LOGGING["loggers"].update(LOGGING_LEDGER["loggers"])
+```
+
+## Highlights<a name="highlights"></a>
+
+![Screenshot 2024-05-14 121014](https://github.com/Geuthur/aa-ledger/assets/761682/d0604260-b672-4bf5-a16a-d1b90557744d)
+
+![Screenshot 2024-05-14 121025](https://github.com/Geuthur/aa-ledger/assets/761682/f8f20e6a-d37d-4a50-a1aa-8615c0f8e88b)
+
+![Screenshot 2024-05-14 120944](https://github.com/Geuthur/aa-ledger/assets/761682/2d695369-1331-4be9-8adf-9c6dabf80dda)
+
+![Screenshot 2024-05-14 121001](https://github.com/Geuthur/aa-ledger/assets/761682/463b9921-150c-42c1-8c3e-eee0f5cfc2bb)
+
+> \[!NOTE\]
+> Contributing
+> You want to improve the project?
+> Just Make a [Pull Request](https://github.com/Geuthur/aa-ledger/pulls) with the Guidelines.
+> We Using pre-commit

aa_ledger-0.3.3/ledger/__init__.py

@@ -0,0 +1,8 @@
+"""Initialize the app"""
+
+from ledger.app_settings import LEDGER_APP_NAME
+
+__version__ = "0.3.3"
+__title__ = "Ledger"
+
+USER_AGENT_TEXT = f"{LEDGER_APP_NAME} v{__version__}"

aa_ledger-0.3.3/ledger/admin.py

@@ -0,0 +1,110 @@
+"""Admin models"""
+
+from django.contrib import admin
+from django.utils.html import format_html
+
+from allianceauth.eveonline.evelinks import eveimageserver
+
+from ledger.models.characteraudit import CharacterAudit
+from ledger.models.corporationaudit import CorporationAudit
+
+
+@admin.register(CorporationAudit)
+class CorporationAuditAdmin(admin.ModelAdmin):
+    list_display = (
+        "_entity_pic",
+        "_corporation__corporation_id",
+        "_last_update_wallet",
+    )
+
+    list_display_links = (
+        "_entity_pic",
+        "_corporation__corporation_id",
+    )
+
+    list_select_related = ("corporation",)
+
+    ordering = ["corporation__corporation_name"]
+
+    search_fields = ["corporation__corporation_name", "corporation__corporation_id"]
+
+    actions = [
+        "delete_objects",
+    ]
+
+    @admin.display(description="")
+    def _entity_pic(self, obj: CorporationAudit):
+        eve_id = obj.corporation.corporation_id
+        return format_html(
+            '<img src="{}" class="img-circle">',
+            eveimageserver._eve_entity_image_url("corporation", eve_id, 32),
+        )
+
+    @admin.display(description="Corporation ID", ordering="corporation__corporation_id")
+    def _corporation__corporation_id(self, obj: CorporationAudit):
+        return obj.corporation.corporation_id
+
+    @admin.display(description="Last Update Wallet", ordering="last_update_wallet")
+    def _last_update_wallet(self, obj: CorporationAudit):
+        return obj.last_update_wallet
+
+    # pylint: disable=unused-argument
+    def has_add_permission(self, request):
+        return False
+
+    # pylint: disable=unused-argument
+    def has_change_permission(self, request, obj=None):
+        return False
+
+
+@admin.register(CharacterAudit)
+class CharacterAuditAdmin(admin.ModelAdmin):
+    list_display = (
+        "_entity_pic",
+        "_character__character_name",
+        "_last_update_wallet",
+        "_last_update_mining",
+    )
+
+    list_display_links = (
+        "_entity_pic",
+        "_character__character_name",
+    )
+
+    list_select_related = ("character",)
+
+    ordering = ["character__character_name"]
+
+    search_fields = ["character__character_name"]
+
+    actions = [
+        "delete_objects",
+    ]
+
+    @admin.display(description="")
+    def _entity_pic(self, obj: CharacterAudit):
+        eve_id = obj.character.character_id
+        return format_html(
+            '<img src="{}" class="img-circle">',
+            eveimageserver._eve_entity_image_url("character", eve_id, 32),
+        )
+
+    @admin.display(description="Character Name", ordering="character__character_name")
+    def _character__character_name(self, obj: CharacterAudit):
+        return obj.character.character_name
+
+    @admin.display(description="Last Update Wallet", ordering="last_update_wallet")
+    def _last_update_wallet(self, obj: CharacterAudit):
+        return obj.last_update_wallet
+
+    @admin.display(description="Last Update Mining", ordering="last_update_mining")
+    def _last_update_mining(self, obj: CharacterAudit):
+        return obj.last_update_mining
+
+    # pylint: disable=unused-argument
+    def has_add_permission(self, request):
+        return False
+
+    # pylint: disable=unused-argument
+    def has_change_permission(self, request, obj=None):
+        return False

aa_ledger-0.3.3/ledger/api/__init__.py

@@ -0,0 +1,24 @@
+from ninja import NinjaAPI
+from ninja.security import django_auth
+
+from django.conf import settings
+
+from ledger.api import character, corporation
+from ledger.hooks import get_extension_logger
+
+logger = get_extension_logger(__name__)
+
+api = NinjaAPI(
+    title="Geuthur API",
+    version="0.1.0",
+    urls_namespace="ledger:new_api",
+    auth=django_auth,
+    csrf=True,
+    openapi_url=settings.DEBUG and "/openapi.json" or "",
+)
+
+# Add the character endpoints
+character.setup(api)
+
+# Add the corporation endpoints
+corporation.setup(api)

aa_ledger-0.3.3/ledger/api/character/__init__.py

@@ -0,0 +1,7 @@
+from .ledger import LedgerApiEndpoints
+from .template import LedgerTemplateApiEndpoints
+
+
+def setup(api):
+    LedgerApiEndpoints(api)
+    LedgerTemplateApiEndpoints(api)