evewiki 0.0.1.dev1__tar.gz → 0.0.1.dev3__tar.gz

{evewiki-0.0.1.dev1 → evewiki-0.0.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evewiki
-Version: 0.0.1.dev1
+Version: 0.0.1.dev3
 Summary: Wiki plugin app for Alliance Auth.
 Author-email: Ryan Cunning <ryan.cunning@gmail.com>
 Requires-Python: >=3.8
@@ -27,7 +27,7 @@ Project-URL: Homepage, https://gitlab.com/cunningdesigns/aa-wiki
 Project-URL: Source, https://gitlab.com/cunningdesigns/aa-wiki
 Project-URL: Tracker, https://gitlab.com/cunningdesigns/aa-wiki/-/issues
 
-# aa-wiki
+# evewiki
 
 Wiki plugin for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) to curate content.
 
@@ -61,61 +61,26 @@ You can alter them by adding a record to the `Settings` section/table in the `ev
 
 ## Installation
 
-*Assumes setup of AA as per the [documentation](https://allianceauth.readthedocs.io/en/latest/installation-containerized/docker.html)*
-Final folder structure would look like
-```plaintext
-aa-dev
-├─ aa-docker
-└─ aa-wiki
-
-```
+### Step 1 - Pre_Requisites
 
-Traverse into the `aa-dev` folder and clone the repo
-```bash
-git clone https://gitlab.com/cunningdesigns/aa-wiki.git
-```
+Evewiki is an App for Alliance Auth, Please make sure you have this installed. Evewiki is not a standalone Django Application
 
-Traverse to `../aa-docker` folder
+### Step 2 - Install app
 
-Bind-mount the plugin-folder in `aa-docker/docker-compose.yml`
-```yaml
-x-allianceauth-base:
-  volumes:
-    - ../aa-wiki:/home/allianceauth/evewiki
-```
+pip install evewiki
 
-___
-*there has to be a better way*
-> Replace `aa-wiki/evewiki/views.py` with content from [example plugin](https://gitlab.com/ErikKalkoken/allianceauth-example-plugin/-/blob/master/example/views.py?ref_type=heads)
+### Step 3 - Configure Auth settings
 
-> Comment out lines 11,12 & 14 on `aa-wiki/evewiki/urls.py`
-___
+Configure your Auth settings (`local.py`) as follows:
 
-Start the containers (may require sudo)
-```bash
-docker compose --env-file=.env up -d
-```
+- Add the following `INSTALLED_APPS` in `local.py`
 
-Open a terminal in the gunicorn container, initiate the plugin install
-```bash
-docker compose exec allianceauth_gunicorn bash
-pip install -e ../evewiki
-```
-
-add `evewiki` to `aa-docker/conf/local.py`
-
-Apply migrations and exit
-```bash
-python manage.py migrate
+```plaintext
+'evewiki',
 ```
 
-restart AA
-```bash
-docker compose restart allianceauth_gunicorn
-```
+### Step 4
 
-___
-*there has to be a better way*
-> Remember to undo the modifications to `evewiki/evewiki/views.py` & `evewiki/evewiki/urls.py`
-___
+In AA admin site add Permissions `evewiki | general | Can access this app` and `evewiki | general | Can edit this app` to the desired `States` / `Groups`
+i.e. you may wish to create a `wiki_editors` group to restrict the `Can edit this app` controls.
 

{evewiki-0.0.1.dev1 → evewiki-0.0.1.dev3}/README.md

@@ -1,4 +1,4 @@
-# aa-wiki
+# evewiki
 
 Wiki plugin for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) to curate content.
 
@@ -32,60 +32,25 @@ You can alter them by adding a record to the `Settings` section/table in the `ev
 
 ## Installation
 
-*Assumes setup of AA as per the [documentation](https://allianceauth.readthedocs.io/en/latest/installation-containerized/docker.html)*
-Final folder structure would look like
-```plaintext
-aa-dev
-├─ aa-docker
-└─ aa-wiki
-
-```
+### Step 1 - Pre_Requisites
 
-Traverse into the `aa-dev` folder and clone the repo
-```bash
-git clone https://gitlab.com/cunningdesigns/aa-wiki.git
-```
+Evewiki is an App for Alliance Auth, Please make sure you have this installed. Evewiki is not a standalone Django Application
 
-Traverse to `../aa-docker` folder
+### Step 2 - Install app
 
-Bind-mount the plugin-folder in `aa-docker/docker-compose.yml`
-```yaml
-x-allianceauth-base:
-  volumes:
-    - ../aa-wiki:/home/allianceauth/evewiki
-```
+pip install evewiki
 
-___
-*there has to be a better way*
-> Replace `aa-wiki/evewiki/views.py` with content from [example plugin](https://gitlab.com/ErikKalkoken/allianceauth-example-plugin/-/blob/master/example/views.py?ref_type=heads)
+### Step 3 - Configure Auth settings
 
-> Comment out lines 11,12 & 14 on `aa-wiki/evewiki/urls.py`
-___
+Configure your Auth settings (`local.py`) as follows:
 
-Start the containers (may require sudo)
-```bash
-docker compose --env-file=.env up -d
-```
+- Add the following `INSTALLED_APPS` in `local.py`
 
-Open a terminal in the gunicorn container, initiate the plugin install
-```bash
-docker compose exec allianceauth_gunicorn bash
-pip install -e ../evewiki
-```
-
-add `evewiki` to `aa-docker/conf/local.py`
-
-Apply migrations and exit
-```bash
-python manage.py migrate
+```plaintext
+'evewiki',
 ```
 
-restart AA
-```bash
-docker compose restart allianceauth_gunicorn
-```
+### Step 4
 
-___
-*there has to be a better way*
-> Remember to undo the modifications to `evewiki/evewiki/views.py` & `evewiki/evewiki/urls.py`
-___
+In AA admin site add Permissions `evewiki | general | Can access this app` and `evewiki | general | Can edit this app` to the desired `States` / `Groups`
+i.e. you may wish to create a `wiki_editors` group to restrict the `Can edit this app` controls.

{evewiki-0.0.1.dev1 → evewiki-0.0.1.dev3}/evewiki/__init__.py

@@ -3,4 +3,4 @@
 # pylint: disable = invalid-name
 default_app_config = "evewiki.apps.EveWikiConfig"
 
-__version__ = "0.0.1.dev1"
+__version__ = "0.0.1.dev3"

{evewiki-0.0.1.dev1 → evewiki-0.0.1.dev3}/evewiki/auth_hooks.py

@@ -3,7 +3,7 @@ from django.utils.translation import gettext_lazy as _
 from allianceauth import hooks
 from allianceauth.services.hooks import MenuItemHook, UrlHook
 
-from . import urls
+from evewiki import urls
 
 
 class EveWikiMenuItem(MenuItemHook):

evewiki-0.0.1.dev3/evewiki/forms.py

@@ -0,0 +1,33 @@
+from django import forms
+
+from .models.pages import Page
+
+
+class PageForm(forms.ModelForm):
+
+    try:
+        # Customised ddl inferring additional context via text-indentation
+        parent = forms.ChoiceField(
+            choices=Page.list(),
+            required=False,
+            label="Path",
+            help_text=Page._meta.get_field("parent").help_text,
+        )
+
+        class Meta:
+            model = Page
+            fields = ["title", "parent", "slug", "priority", "states", "groups"]
+
+        def clean(self):
+            """
+            Django needs a little help to turn the custom `parent` field back into a model.
+            """
+            cleaned_data = super().clean()
+            parent_id = cleaned_data["parent"]
+            cleaned_data["parent"] = (
+                Page.objects.get(pk=int(parent_id)) if parent_id else None
+            )
+            return cleaned_data
+
+    except Exception as e:
+        print(f"setup required: {e}")

evewiki-0.0.1.dev3/evewiki/templates/evewiki/error.html

@@ -0,0 +1,13 @@
+{% block details %}
+<h1>Setup Required</h1>
+
+{% endblock %}
+
+{% block extra_javascript %}
+{% endblock %}
+
+{% block extra_css %}
+{% endblock %}
+
+{% block extra_script %}
+{% endblock %}

{evewiki-0.0.1.dev1 → evewiki-0.0.1.dev3}/evewiki/urls.py

@@ -2,7 +2,7 @@
 
 from django.urls import path, re_path
 
-from . import views
+from evewiki import views
 
 app_name = "evewiki"
 

evewiki-0.0.1.dev3/evewiki/views.py

@@ -0,0 +1,169 @@
+"""Views."""
+
+from django.contrib import messages
+from django.contrib.auth.decorators import login_required, permission_required
+from django.core.handlers.wsgi import WSGIRequest
+from django.http import HttpResponse
+from django.shortcuts import redirect, render
+
+from allianceauth.authentication.models import UserProfile
+
+from .forms import PageForm
+from .models.logs import Log
+from .models.page_versions import PageVersion
+from .models.pages import Page
+from .models.settings import Setting
+
+
+@login_required
+@permission_required("evewiki.basic_access")
+def index(request: WSGIRequest, unknown_path: str = "/"):
+    """Render index view."""
+
+    try:
+
+        settings = Setting.get_settings()
+
+        is_editor = False
+        if request.user.has_perm("evewiki.editor_access"):
+            is_editor = True
+
+        # Control light/dark mode on md editor
+        dark_mode = False
+        themes_to_use_dark_mode = [
+            "allianceauth.theme.darkly.auth_hooks.DarklyThemeHook"
+        ]
+        user = UserProfile.objects.filter(user=request.user).first()
+        if user.theme in themes_to_use_dark_mode:
+            dark_mode = True
+
+        # Tree is too complex to call directly froma template
+        tree = Page.tree(user=request.user)
+
+        # "Unknown" i.e. has not bee picked up by urls.py
+        page = Page.get_by_path(path=unknown_path, user=request.user)
+
+        # Load the first page by default if nothing else can be found
+        # If there is no first-page, template will load a help page.
+        if page is None:
+            page = Page.objects.order_by("id").first()
+
+        # Content save
+        new_content = request.POST.get("content")
+        if new_content is not None:
+            try:
+                # Save the content
+                page.content = request.POST.get("content")
+                page.save()
+                # Record a version of the content
+                page_version = PageVersion(
+                    page=page,
+                    user=user,
+                    content=page.content,
+                )
+                page_version.save()
+                # Log a thing happened
+                Log(user=user, action=f"Page content modified: {page.title}").save()
+                messages.success(request, f"Page '{page.title}' saved")
+                return redirect(f"/evewiki/{page.path}")
+            except Page.DoesNotExist:
+                pass
+
+        context = {
+            "context-title": "context-not-title",
+            "tree": tree,
+            "page": page,
+            "dark_mode": dark_mode,
+            "settings": settings,
+            "is_editor": is_editor,
+        }
+        return render(request, "evewiki/index.html", context)
+    except Exception as e:
+        print(f"setup required: {e}")
+        return render(request, "evewiki/error.html")
+
+
+@login_required
+@permission_required("evewiki.basic_access")
+def page(request: WSGIRequest) -> HttpResponse:
+
+    try:
+        if (
+            not request.user.has_perm("evewiki.editor_access")
+            and not request.user.profile.state.name == "Admin"
+        ):
+            return redirect("/evewiki")
+
+        user = UserProfile.objects.filter(user=request.user).first()
+        page = None
+        page_id = request.GET.get("id") or request.POST.get("id")
+        if page_id is not None:
+            try:
+                page = Page.objects.get(id=page_id)
+            except Page.DoesNotExist:
+                page = None
+
+        if request.method == "POST":
+            form = PageForm(request.POST, instance=page)
+            if form.is_valid():
+                saved_page = form.save()
+                Log(user=user, action=f"Page Created: {saved_page.title}").save()
+                messages.success(request, f"Page '{saved_page.title}' saved")
+                return redirect(f"/evewiki/{saved_page.path}")
+        else:
+            form = PageForm(instance=page)
+
+        page_versions = PageVersion.objects.filter(page=page).order_by("-created").all()
+
+        context = {
+            "Page": "Page",
+            "page": page,
+            "form": form,
+            "versions": page_versions,
+        }
+        return render(request, "evewiki/page.html", context)
+    except Exception as e:
+        print(f"setup required: {e}")
+        return render(request, "evewiki/error.html")
+
+
+@login_required
+@permission_required("evewiki.basic_access")
+def page_delete(request: WSGIRequest) -> HttpResponse:
+
+    try:
+        if (
+            not request.user.has_perm("evewiki.editor_access")
+            and not request.user.profile.state.name == "Admin"
+        ):
+            return redirect("/evewiki")
+
+        user = UserProfile.objects.filter(user=request.user).first()
+        page = None
+        page_id = request.GET.get("id")
+        confirm_delete = request.GET.get("confirm_delete")
+        if page_id is not None:
+            try:
+                page = Page.objects.get(id=page_id)
+            except Page.DoesNotExist:
+                page = None
+
+        # Check if page has children
+        children = Page.objects.filter(parent_id=page_id).all()
+        if len(children) > 0:
+            messages.error(request, "You cannot delete a page that has children.")
+
+        # Confirm the confirmation that this user definitely wants to delete
+        if confirm_delete == "true":
+            messages.success(request, f"Page '{page.title}' deleted")
+            page.delete()
+            # Pages can be deleted, links can be broken, versions orphaned.
+            # But the log is immutable
+            Log(user=user, action=f"Page Deleted: {page.title}").save()
+            return redirect("/evewiki/index")
+
+        context = {"Delete Page": "Delete Page", "page": page, "children": children}
+        return render(request, "evewiki/page_delete.html", context)
+    except Exception as e:
+        print(f"setup required: {e}")
+        return render(request, "evewiki/error.html")

evewiki-0.0.1.dev1/evewiki/forms.py

@@ -1,29 +0,0 @@
-from django import forms
-
-from .models.pages import Page
-
-
-class PageForm(forms.ModelForm):
-
-    # Customised ddl inferring additional context via text-indentation
-    parent = forms.ChoiceField(
-        choices=Page.list(),
-        required=False,
-        label="Path",
-        help_text=Page._meta.get_field("parent").help_text,
-    )
-
-    class Meta:
-        model = Page
-        fields = ["title", "parent", "slug", "priority", "states", "groups"]
-
-    def clean(self):
-        """
-        Django needs a little help to turn the custom `parent` field back into a model.
-        """
-        cleaned_data = super().clean()
-        parent_id = cleaned_data["parent"]
-        cleaned_data["parent"] = (
-            Page.objects.get(pk=int(parent_id)) if parent_id else None
-        )
-        return cleaned_data

evewiki-0.0.1.dev1/evewiki/views.py

@@ -1,149 +0,0 @@
-"""Views."""
-
-from django.contrib import messages
-from django.contrib.auth.decorators import login_required, permission_required
-from django.core.handlers.wsgi import WSGIRequest
-from django.http import HttpResponse
-from django.shortcuts import redirect, render
-
-from allianceauth.authentication.models import UserProfile
-
-from .forms import PageForm
-from .models.logs import Log
-from .models.page_versions import PageVersion
-from .models.pages import Page
-from .models.settings import Setting
-
-
-@login_required
-@permission_required("evewiki.basic_access")
-def index(request: WSGIRequest, unknown_path: str = "/"):
-    """Render index view."""
-
-    settings = Setting.get_settings()
-
-    is_editor = False
-    if request.user.has_perm("evewiki.editor_access"):
-        is_editor = True
-
-    # Control light/dark mode on md editor
-    dark_mode = False
-    themes_to_use_dark_mode = ["allianceauth.theme.darkly.auth_hooks.DarklyThemeHook"]
-    user = UserProfile.objects.filter(user=request.user).first()
-    if user.theme in themes_to_use_dark_mode:
-        dark_mode = True
-
-    # Tree is too complex to call directly froma template
-    tree = Page.tree(user=request.user)
-
-    # "Unknown" i.e. has not bee picked up by urls.py
-    page = Page.get_by_path(path=unknown_path, user=request.user)
-
-    # Load the first page by default if nothing else can be found
-    # If there is no first-page, template will load a help page.
-    if page is None:
-        page = Page.objects.order_by("id").first()
-
-    # Content save
-    new_content = request.POST.get("content")
-    if new_content is not None:
-        try:
-            # Save the content
-            page.content = request.POST.get("content")
-            page.save()
-            # Record a version of the content
-            page_version = PageVersion(
-                page=page,
-                user=user,
-                content=page.content,
-            )
-            page_version.save()
-            # Log a thing happened
-            Log(user=user, action=f"Page content modified: {page.title}").save()
-            messages.success(request, f"Page '{page.title}' saved")
-            return redirect(f"/evewiki/{page.path}")
-        except Page.DoesNotExist:
-            pass
-
-    context = {
-        "context-title": "context-not-title",
-        "tree": tree,
-        "page": page,
-        "dark_mode": dark_mode,
-        "settings": settings,
-        "is_editor": is_editor,
-    }
-    return render(request, "evewiki/index.html", context)
-
-
-@login_required
-@permission_required("evewiki.basic_access")
-def page(request: WSGIRequest) -> HttpResponse:
-
-    if (
-        not request.user.has_perm("evewiki.editor_access")
-        and not request.user.profile.state.name == "Admin"
-    ):
-        return redirect("/evewiki")
-
-    user = UserProfile.objects.filter(user=request.user).first()
-    page = None
-    page_id = request.GET.get("id") or request.POST.get("id")
-    if page_id is not None:
-        try:
-            page = Page.objects.get(id=page_id)
-        except Page.DoesNotExist:
-            page = None
-
-    if request.method == "POST":
-        form = PageForm(request.POST, instance=page)
-        if form.is_valid():
-            saved_page = form.save()
-            Log(user=user, action=f"Page Created: {saved_page.title}").save()
-            messages.success(request, f"Page '{saved_page.title}' saved")
-            return redirect(f"/evewiki/{saved_page.path}")
-    else:
-        form = PageForm(instance=page)
-
-    page_versions = PageVersion.objects.filter(page=page).order_by("-created").all()
-
-    context = {"Page": "Page", "page": page, "form": form, "versions": page_versions}
-    return render(request, "evewiki/page.html", context)
-
-
-@login_required
-@permission_required("evewiki.basic_access")
-def page_delete(request: WSGIRequest) -> HttpResponse:
-
-    if (
-        not request.user.has_perm("evewiki.editor_access")
-        and not request.user.profile.state.name == "Admin"
-    ):
-        return redirect("/evewiki")
-
-    user = UserProfile.objects.filter(user=request.user).first()
-    page = None
-    page_id = request.GET.get("id")
-    confirm_delete = request.GET.get("confirm_delete")
-    if page_id is not None:
-        try:
-            page = Page.objects.get(id=page_id)
-        except Page.DoesNotExist:
-            page = None
-
-    # Check if page has children
-    children = Page.objects.filter(parent_id=page_id).all()
-    if len(children) > 0:
-        messages.error(request, "You cannot delete a page that has children.")
-
-    # Confirm the confirmation that this user definitely wants to delete
-    if confirm_delete == "true":
-        messages.success(request, f"Page '{page.title}' deleted")
-        page.delete()
-        # Pages can be deleted, links can be broken, versions orphaned.
-        # But the log is immutable
-        Log(user=user, action=f"Page Deleted: {page.title}").save()
-        return redirect("/evewiki/index")
-
-    context = {"Delete Page": "Delete Page", "page": page, "children": children}
-    return render(request, "evewiki/page_delete.html", context)