structables 0.3.5__tar.gz → 0.3.7__tar.gz

structables-0.3.7/.env.example

@@ -0,0 +1,3 @@
+PORT=8002
+UWSGI_PROCESSES=4
+UWSGI_THREADS=4

structables-0.3.7/.forgejo/workflows/docker.yml

@@ -0,0 +1,33 @@
+name: Docker CI/CD
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  docker:
+    name: Docker Build and Push to Docker Hub
+    container:
+      image: node:20-bookworm
+    steps:
+      - name: Install dependencies
+        run: |
+          apt update
+          apt install -y docker.io
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push to Docker Hub
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          tags: |
+            privatecoffee/structables:latest
+            privatecoffee/structables:${{ env.GITHUB_REF_NAME }}

{structables-0.3.5 → structables-0.3.7}/.gitignore

@@ -1,6 +1,9 @@
-venv/
-*.pyc
-__pycache__/
+.env
 .vscode
+__pycache__/
+dist/
+docker-compose.yml
+privacy.md
 privacy.txt
-/dist/
+*.pyc
+venv/

structables-0.3.7/Dockerfile

@@ -0,0 +1,17 @@
+FROM alpine:3.20
+
+ENV APP_ENV=/opt/venv
+ENV PATH="${APP_ENV}/bin:$PATH"
+
+RUN apk add --no-cache py3-pip uwsgi-python3 && \
+  python3 -m venv $APP_ENV && \
+  $APP_ENV/bin/pip install --no-cache-dir pip structables && \
+  adduser -S -D -H structables
+
+COPY entrypoint.sh /entrypoint.sh
+
+EXPOSE 8002
+
+USER structables
+
+ENTRYPOINT ["/entrypoint.sh"]

{structables-0.3.5 → structables-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structables
-Version: 0.3.5
+Version: 0.3.7
 Summary: A simple frontend for Instructables
 Project-URL: Homepage, https://git.private.coffee/privatecoffee/structables
 Project-URL: Bug Tracker, https://git.private.coffee/privatecoffee/structables/issues
@@ -674,6 +674,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Requires-Dist: bs4
 Requires-Dist: flask
+Requires-Dist: markdown2[all]
 Description-Content-Type: text/markdown
 
 <img align="right" src="src/structables/static/img/logo.png">
@@ -691,9 +692,10 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 
 ## Instances
 
-| URL                                                                        | Provided by                               | Country | Comments |
-| -------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
-| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
+| URL                                                               | Provided by                               | Country | Comments |
+| ----------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
+| [structables.private.coffee](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
+| [structables.bloat.cat](https://structables.bloat.cat/)           | [Bloat.cat](https://bloat.cat)            | Romania |          |
 
 To add your own instance to this list, please open a pull request or issue.
 
@@ -705,7 +707,7 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 
 ## Run your own instance
 
-### Production
+### Production: Manual
 
 1. Create a virtual environment: `python3 -m venv venv`
 2. Activate the virtual environment: `source venv/bin/activate`
@@ -714,6 +716,19 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 5. Point your reverse proxy to http://localhost:8002 and (optionally) serve static files from the `venv/lib/pythonX.XX/site-packages/structables/static` directory
 6. Connect to your instance under your domain
 
+### Production: Docker
+
+1. Copy `.env.example` to `.env` and adjust the settings as necessary
+2. Copy `docker-compose-example.yml` to `docker-compose.yml` and adjust it as necessary, for example modifying resource limits or changing the port/host configuration
+3. Build and run the Docker container:
+
+   ```sh
+   docker-compose up [-d]
+   ```
+
+4. Point your reverse proxy to http://127.0.0.1:8002 (or your chosen port, if you modified it) and (optionally) serve static files from `structables/static`
+5. Connect to your instance under your domain
+
 ### Development
 
 1. Clone the repository: `git clone https://git.private.coffee/privatecoffee/structables.git && cd structables`

{structables-0.3.5 → structables-0.3.7}/README.md

@@ -13,9 +13,10 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 
 ## Instances
 
-| URL                                                                        | Provided by                               | Country | Comments |
-| -------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
-| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
+| URL                                                               | Provided by                               | Country | Comments |
+| ----------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
+| [structables.private.coffee](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
+| [structables.bloat.cat](https://structables.bloat.cat/)           | [Bloat.cat](https://bloat.cat)            | Romania |          |
 
 To add your own instance to this list, please open a pull request or issue.
 
@@ -27,7 +28,7 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 
 ## Run your own instance
 
-### Production
+### Production: Manual
 
 1. Create a virtual environment: `python3 -m venv venv`
 2. Activate the virtual environment: `source venv/bin/activate`
@@ -36,6 +37,19 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 5. Point your reverse proxy to http://localhost:8002 and (optionally) serve static files from the `venv/lib/pythonX.XX/site-packages/structables/static` directory
 6. Connect to your instance under your domain
 
+### Production: Docker
+
+1. Copy `.env.example` to `.env` and adjust the settings as necessary
+2. Copy `docker-compose-example.yml` to `docker-compose.yml` and adjust it as necessary, for example modifying resource limits or changing the port/host configuration
+3. Build and run the Docker container:
+
+   ```sh
+   docker-compose up [-d]
+   ```
+
+4. Point your reverse proxy to http://127.0.0.1:8002 (or your chosen port, if you modified it) and (optionally) serve static files from `structables/static`
+5. Connect to your instance under your domain
+
 ### Development
 
 1. Clone the repository: `git clone https://git.private.coffee/privatecoffee/structables.git && cd structables`

structables-0.3.7/docker-compose-example.yml

@@ -0,0 +1,18 @@
+services:
+  structables:
+    container_name: structables
+    restart: unless-stopped
+    build: .
+    ports:
+      - "127.0.0.1:8002:8002"
+    env_file: .env
+    security_opt:
+      - no-new-privileges:true
+    cap_drop:
+      - ALL
+    read_only: true
+    deploy:
+      resources:
+        limits:
+          cpus: '0.5'
+          memory: 300M

structables-0.3.7/entrypoint.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+args="--plugin python3 \
+	--http-socket 0.0.0.0:$PORT \
+	--master \
+	--module structables.main:app \
+	-H /opt/venv"
+
+if [ "$UWSGI_PROCESSES" ]
+then
+	args="$args --processes $UWSGI_PROCESSES"
+fi
+
+if [ "$UWSGI_THREADS" ]
+then
+	args="$args --threads $UWSGI_THREADS"
+fi
+
+exec /usr/sbin/uwsgi $args

{structables-0.3.5 → structables-0.3.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "structables"
-version = "0.3.5"
+version = "0.3.7"
 authors = [
   { name="Private.coffee Team", email="support@private.coffee" },
 ]
@@ -20,6 +20,7 @@ classifiers = [
 dependencies = [
   "flask",
   "bs4",
+  "markdown2[all]",
 ]
 
 [project.scripts]

{structables-0.3.5 → structables-0.3.7}/src/structables/config.py

@@ -6,7 +6,7 @@ class Config:
     LISTEN_HOST = os.environ.get("STRUCTABLES_LISTEN_HOST", "127.0.0.1")
     INVIDIOUS = os.environ.get("STRUCTABLES_INVIDIOUS")
     UNSAFE = os.environ.get("STRUCTABLES_UNSAFE", False)
-    PRIVACY_FILE = os.environ.get("STRUCTABLES_PRIVACY_FILE", "privacy.txt")
+    PRIVACY_FILE = os.environ.get("STRUCTABLES_PRIVACY_FILE")
 
     @staticmethod
     def init_app(app):

structables-0.3.7/src/structables/main.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+
+from flask import Flask
+import threading
+import time
+
+from .config import Config
+from .routes import init_routes
+from .utils.data import update_data
+from .utils.helpers import get_typesense_api_key
+
+app = Flask(__name__, template_folder="templates", static_folder="static")
+app.config.from_object(Config)
+app.typesense_api_key = get_typesense_api_key()
+
+init_routes(app)
+
+
+def background_update_data(app):
+    """Runs the update_data function every 5 minutes.
+
+    This replaces the need for a cron job to update the data.
+
+    Args:
+        app (Flask): The Flask app instance.
+    """
+    while True:
+        update_data(app)
+        time.sleep(300)
+
+
+def main():
+    threading.Thread(target=background_update_data, args=(app,), daemon=True).start()
+    app.run(
+        port=app.config["PORT"],
+        host=app.config["LISTEN_HOST"],
+        debug=app.config["DEBUG"],
+    )
+
+
+if __name__ == "__main__":
+    main()

{structables-0.3.5 → structables-0.3.7}/src/structables/routes/main.py

@@ -4,6 +4,7 @@ from urllib.error import HTTPError
 from bs4 import BeautifulSoup
 from urllib.parse import quote
 from werkzeug.exceptions import InternalServerError
+from markdown2 import Markdown
 from traceback import print_exc
 import pathlib
 import json
@@ -342,11 +343,24 @@ def init_main_routes(app):
 
         content = "No privacy policy found."
 
-        path = app.config.get("PRIVACY_FILE", "privacy.txt")
+        path = app.config.get("PRIVACY_FILE")
+
+        if not path:
+            if pathlib.Path("privacy.md").exists():
+                path = "privacy.md"
+
+            elif pathlib.Path("privacy.txt").exists():
+                path = "privacy.txt"
 
         try:
             with pathlib.Path(path).open() as f:
                 content = f.read()
+
+                print(path, content)
+
+                if path.endswith(".md"):
+                    content = Markdown().convert(content)
+                    
         except OSError:
             pass
 

structables-0.3.5/src/structables/main.py

@@ -1,23 +0,0 @@
-#!/usr/bin/env python
-
-from flask import Flask
-
-from .config import Config
-from .routes import init_routes
-from .utils.data import update_data
-from .utils.helpers import get_typesense_api_key
-
-app = Flask(__name__, template_folder="templates", static_folder="static")
-app.config.from_object(Config)
-app.typesense_api_key = get_typesense_api_key()
-
-init_routes(app)
-
-def main():
-    app.run(port=app.config['PORT'], host=app.config['LISTEN_HOST'], debug=app.config['DEBUG'])
-
-if __name__ == "__main__":
-    main()
-
-# Initialize data when the server starts
-update_data(app)