Project structure

.github/workflows/docker.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Build & export
         uses: docker/build-push-action@v3
         with:
-          file: docker/Dockerfile
+          file: Dockerfile
           push: false
           tags: ${{ steps.meta.outputs.tags }}
           outputs: type=docker,dest=/tmp/wikmd.tar
@@ -96,6 +96,10 @@ jobs:
       - name: Assert wikmd status
         run: curl -I localhost:5000 2>&1 | awk '/HTTP\// {print $2}' | grep -w "200\|301"
 
+      # Check that wikmd is rendering
+      - name: Check wikmd rendering status
+        run: curl -s localhost:5000 | grep -w "What is it?"
+
   publish:
     # Publish if official repo and push to 'main' or new tag
     if: |
@@ -116,6 +120,6 @@ jobs:
       - name: Publish
         uses: docker/build-push-action@v3
         with:
-          file: docker/Dockerfile
+          file: Dockerfile
           push: true
           tags: ${{ needs.build.outputs.wikmd_tags }}

.github/workflows/main.yml

@@ -21,15 +21,16 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install .[dev]
     - name: Test with pytest
       run: |
-        python -m pytest -v 
+        python -m pytest
         
     - name: Start wikmd
-      run: python wiki.py &
-
+      run: |
+        cd src
+        python -m wikmd.wiki &
+
     - name: screenshots-ci-action
       uses: flameddd/screenshots-ci-action@master
       with:

.gitignore

@@ -96,15 +96,12 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# Generated plugin files
+src/wikmd/plugins/draw/drawings/*
+!src/wikmd/plugins/draw/drawings/.gitkeep
+
+
 # Personal wiki pages
 wiki/*
-wiki/src/*
-
-!wiki/Features.md
-!wiki/How to use the wiki.md
-!wiki/Markdown cheatsheet.md
-!wiki/Using the version control system.md
-!wiki/homepage.md
-!wiki/src
 
 temp/*

docker/README.md → DOCKER.md

@@ -2,18 +2,14 @@
 
 [wikmd](https://github.com/Linbreux/wikmd) is a file based wiki that uses markdown.
 
-This repo provides Docker files that are loosely based on those of the [linuxserver](https://www.linuxserver.io/) community.
-
-Docker files are available for arm, arm64 and amd64.
-
 ## Usage
 
 Here are some example snippets to help you get started creating a container.
 
 Build the image,
 
 ```bash
-docker build -t linbreux/wikmd:latest -f docker/Dockerfile .
+docker build -t linbreux/wikmd:latest -f Dockerfile .
 ```
 
 ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))

Dockerfile

@@ -0,0 +1,41 @@
+FROM python:3.9-alpine3.17 as final
+
+RUN apk update
+RUN apk add git
+RUN apk add pandoc
+RUN apk add build-base linux-headers
+
+# Prevents Python from writing pyc files.
+ENV PYTHONDONTWRITEBYTECODE=1
+
+# Keeps Python from buffering stdout and stderr to avoid situations where
+# the application crashes without emitting any logs due to buffering.
+ENV PYTHONUNBUFFERED=1
+
+# Create a non-privileged user that the app will run under.
+# See https://docs.docker.com/go/dockerfile-user-best-practices/
+ARG UID=10001
+RUN adduser \
+    --disabled-password \
+    --gecos "" \
+    --home "/nonexistent" \
+    --shell "/sbin/nologin" \
+    --no-create-home \
+    --uid "${UID}" \
+    appuser
+
+WORKDIR /code
+
+COPY ./pyproject.toml /code/
+
+RUN python -m pip install --no-cache-dir --upgrade .
+
+
+COPY ./src/wikmd /code/wikmd
+COPY ./wiki_template /wiki_template
+
+# Expose the port that the application listens on.
+EXPOSE 5000
+
+# Run the application.
+CMD ["python", "-m", "wikmd.wiki"]

README.md

@@ -7,7 +7,7 @@ It’s a file-based wiki that aims to simplicity. Instead of storing the data in
 
 To view the documents in the browser, the document is converted to html.
 
-![preview](static/images/readme-img.png)
+![preview](src/wikmd/static/images/readme-img.png)
 
 ## Features
 

pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+requires-python = ">= 3.8"
+name = "wikmd"
+description = "A file-based wiki that aims for simplicity."
+authors = [
+    { name = "linbreux" }
+]
+
+version = "1.9.0"
+
+dependencies=[
+    "Flask==3.0.2",
+    "GitPython==3.1.42",
+    "Markdown==3.5.2",
+    "PyYAML==6.0.1",
+    "Werkzeug==3.0.1",
+    "Whoosh==2.7.4",
+    "beautifulsoup4==4.12.3",
+    "pandoc-eqnos==2.5.0",
+    "pandoc-fignos==2.4.0",
+    "pandoc-secnos==2.2.2",
+    "pandoc-tablenos==2.3.0",
+    "pandoc-xnos==2.5.0",
+    "pandocfilters==1.5.1",
+    "pypandoc==1.13",
+    "requests==2.31.0",
+    "lxml==5.1.0",
+    "watchdog==2.1.9",
+    "cachelib==0.12.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+
+[tool.ruff]
+src = ["", "tests"]
+select = ["ALL"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    # S101: Check for assert
+    "S101",
+
+    # ANN001: Missing type annotation for public function
+    "ANN001",
+
+    # ANN201: Missing return type annotation for public function
+    "ANN201",
+
+    # D100: Missing docstring in public module
+    "D100",
+
+    # D103: Missing docstring in public function
+    "D103",
+
+    # PLR2004: Magic numbers
+    "PLR2004",
+]