aa-pootest 0.1.0__tar.gz

aa_pootest-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aa-pootest authors
+
+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_pootest-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: aa-pootest
+Version: 0.1.0
+Summary: POO Test plugin app for Alliance Auth.
+Author: PooAmped
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.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>=5
+Requires-Dist: coverage ; extra == "test"
+Requires-Dist: factory_boy ; extra == "test"
+Requires-Dist: allianceauth-app-utils>=1.32 ; extra == "test"
+Project-URL: Homepage, https://github.com/PooAmped/aa-pootest
+Project-URL: Source, https://github.com/PooAmped/aa-pootest
+Project-URL: Tracker, https://github.com/PooAmped/aa-pootest/issues
+Provides-Extra: test
+
+# aa-pootest
+
+A minimal **test plugin** for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) (AA).
+
+It adds a single permission-gated page ("POO Test") to the AA sidebar that renders
+a *Hello, World!* card. Use it to verify your AA dev/prod setup can install and load
+a custom plugin, or as a starting point for your own app.
+
+![License](https://img.shields.io/badge/license-MIT-green)
+
+- **Distribution (pip) name:** `aa-pootest`
+- **Django app / module name:** `pootest`
+
+## Features
+
+- Fully functional Alliance Auth app with a view and a basic permission
+- Sidebar menu entry (visible only to users with the access permission)
+- Installable with the standard AA plugin workflow
+
+## Installation
+
+> Run all commands inside your Alliance Auth virtual environment.
+
+### 1. Install the package
+
+From a local checkout (editable, for development):
+
+```bash
+pip install -e aa-pootest
+```
+
+Or from a built/published package:
+
+```bash
+pip install aa-pootest
+```
+
+Or directly from git:
+
+```bash
+pip install git+https://github.com/PooAmped/aa-pootest
+```
+
+### 2. Enable the app
+
+Add the app's **module name** to `INSTALLED_APPS` in `myauth/settings/local.py`:
+
+```python
+INSTALLED_APPS += [
+    "pootest",
+]
+```
+
+### 3. Run migrations & collect static files
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --noinput
+```
+
+### 4. Restart Alliance Auth
+
+```bash
+supervisorctl restart myauth:
+```
+
+### 5. Grant access
+
+In the AA admin site, grant the permission
+`pootest | general | Can access this app` to the relevant **state** or **group**.
+Users with that permission will then see the **POO Test** entry in the sidebar.
+
+## Settings
+
+| Name                 | Description           | Default |
+| -------------------- | --------------------- | ------- |
+| `POOTEST_SETTING_ONE`| Example optional value| `None`  |
+
+Override in `myauth/settings/local.py` if desired.
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+

aa_pootest-0.1.0/README.md

@@ -0,0 +1,83 @@
+# aa-pootest
+
+A minimal **test plugin** for [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) (AA).
+
+It adds a single permission-gated page ("POO Test") to the AA sidebar that renders
+a *Hello, World!* card. Use it to verify your AA dev/prod setup can install and load
+a custom plugin, or as a starting point for your own app.
+
+![License](https://img.shields.io/badge/license-MIT-green)
+
+- **Distribution (pip) name:** `aa-pootest`
+- **Django app / module name:** `pootest`
+
+## Features
+
+- Fully functional Alliance Auth app with a view and a basic permission
+- Sidebar menu entry (visible only to users with the access permission)
+- Installable with the standard AA plugin workflow
+
+## Installation
+
+> Run all commands inside your Alliance Auth virtual environment.
+
+### 1. Install the package
+
+From a local checkout (editable, for development):
+
+```bash
+pip install -e aa-pootest
+```
+
+Or from a built/published package:
+
+```bash
+pip install aa-pootest
+```
+
+Or directly from git:
+
+```bash
+pip install git+https://github.com/PooAmped/aa-pootest
+```
+
+### 2. Enable the app
+
+Add the app's **module name** to `INSTALLED_APPS` in `myauth/settings/local.py`:
+
+```python
+INSTALLED_APPS += [
+    "pootest",
+]
+```
+
+### 3. Run migrations & collect static files
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --noinput
+```
+
+### 4. Restart Alliance Auth
+
+```bash
+supervisorctl restart myauth:
+```
+
+### 5. Grant access
+
+In the AA admin site, grant the permission
+`pootest | general | Can access this app` to the relevant **state** or **group**.
+Users with that permission will then see the **POO Test** entry in the sidebar.
+
+## Settings
+
+| Name                 | Description           | Default |
+| -------------------- | --------------------- | ------- |
+| `POOTEST_SETTING_ONE`| Example optional value| `None`  |
+
+Override in `myauth/settings/local.py` if desired.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

aa_pootest-0.1.0/pootest/__init__.py

@@ -0,0 +1,6 @@
+"""POO Test plugin app for Alliance Auth."""
+
+# pylint: disable = invalid-name
+default_app_config = "pootest.apps.PootestConfig"
+
+__version__ = "0.1.0"

aa_pootest-0.1.0/pootest/admin.py

@@ -0,0 +1,8 @@
+"""Admin site setup."""
+
+# Register your models with the Django admin site here, e.g.:
+#
+# from django.contrib import admin
+# from .models import MyModel
+#
+# admin.site.register(MyModel)

aa_pootest-0.1.0/pootest/app_settings.py

@@ -0,0 +1,6 @@
+"""App settings."""
+
+from django.conf import settings
+
+# Example optional setting. Override in your AA `settings/local.py` if needed.
+POOTEST_SETTING_ONE = getattr(settings, "POOTEST_SETTING_ONE", None)

aa_pootest-0.1.0/pootest/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+from . import __version__
+
+
+class PootestConfig(AppConfig):
+    name = "pootest"
+    label = "pootest"
+    verbose_name = f"POO Test v{__version__}"

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

aa_pootest-0.1.0/pootest/migrations/0001_initial.py

@@ -0,0 +1,30 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="General",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+            ],
+            options={
+                "permissions": (("basic_access", "Can access this app"),),
+                "managed": False,
+                "default_permissions": (),
+            },
+        ),
+    ]

aa_pootest-0.1.0/pootest/models.py

@@ -0,0 +1,12 @@
+"""Models."""
+
+from django.db import models
+
+
+class General(models.Model):
+    """A meta model for app permissions."""
+
+    class Meta:
+        managed = False
+        default_permissions = ()
+        permissions = (("basic_access", "Can access this app"),)

aa_pootest-0.1.0/pootest/templates/pootest/base.html

@@ -0,0 +1,15 @@
+{% extends 'allianceauth/base-bs5.html' %}
+{% load humanize %}
+{% load i18n %}
+
+{% block page_title %}POO Test{% endblock %}
+
+{% block header_nav_brand %}POO Test{% endblock %}
+
+{% block header_nav_user_character_control %}
+    {% comment %}
+        Leave empty to remove user control nav items for this app
+    {% endcomment %}
+{% endblock %}
+
+{% block content %}{% endblock %}

aa_pootest-0.1.0/pootest/templates/pootest/index.html

@@ -0,0 +1,23 @@
+{% extends 'pootest/base.html' %}
+{% load i18n %}
+{% load humanize %}
+
+{% block content %}
+
+<div class="card card-default card-tabs">
+    <div class="card-body">
+        <h5 class="card-title">Welcome</h5>
+        <p class="card-text">{{ text }}</p>
+    </div>
+</div>
+
+{% endblock %}
+
+{% block extra_javascript %}
+{% endblock %}
+
+{% block extra_css %}
+{% endblock %}
+
+{% block extra_script %}
+{% endblock %}

aa_pootest-0.1.0/pootest/urls.py

@@ -0,0 +1,11 @@
+"""Routes."""
+
+from django.urls import path
+
+from . import views
+
+app_name = "pootest"
+
+urlpatterns = [
+    path("", views.index, name="index"),
+]

aa_pootest-0.1.0/pootest/views.py

@@ -0,0 +1,15 @@
+"""Views."""
+
+from django.contrib.auth.decorators import login_required, permission_required
+from django.shortcuts import render
+
+
+@login_required
+@permission_required("pootest.basic_access")
+def index(request):
+    """Render index view."""
+    context = {
+        "text": "Hello, World! This is aa-pootest.",
+        "page_title": "Welcome",
+    }
+    return render(request, "pootest/index.html", context)

aa_pootest-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "aa-pootest"
+dynamic = ["version", "description"]
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.10"
+authors = [
+    { name = "PooAmped" },
+]
+classifiers = [
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 5.2",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = [
+    "allianceauth>=5",
+]
+
+[project.optional-dependencies]
+test = ["coverage", "factory_boy", "allianceauth-app-utils>=1.32"]
+
+[project.urls]
+Homepage = "https://github.com/PooAmped/aa-pootest"
+Source = "https://github.com/PooAmped/aa-pootest"
+Tracker = "https://github.com/PooAmped/aa-pootest/issues"
+
+[tool.flit.module]
+name = "pootest"
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+sections = [
+    "FUTURE",
+    "STDLIB",
+    "THIRDPARTY",
+    "DJANGO",
+    "ALLIANCEAUTH",
+    "FIRSTPARTY",
+    "LOCALFOLDER"
+]
+known_allianceauth = ["allianceauth", "app_utils"]
+known_django = ["django", "django_webtest", "esi", "eveuniverse"]
+
+[tool.pylint.'MASTER']
+ignore-patterns = ["__init__.py", "auth_hooks.py", "apps.py", "admin.py"]
+ignore-paths = ["^.*/tests/.*$", "^.*/migrations/.*$"]
+
+[tool.pylint.'FORMAT']
+max-line-length = 120