structables 0.2.1__tar.gz → 0.3.0__tar.gz

{structables-0.2.1 → structables-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structables
-Version: 0.2.1
+Version: 0.3.0
 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
@@ -683,7 +683,7 @@ Description-Content-Type: text/markdown
 An open source alternative front-end to Instructables. This is a fork of <a href="https://codeberg.org/indestructables/indestructables">snowcatridge10's Indestructables</a> to get rid of Selenium. Indestructables itself is a fork of <a href="https://git.vern.cc/cobra/Destructables">Cobra's Destructables</a>.
 
 [![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-support%20us!-pink?logo=coffeescript)](https://private.coffee)
-[![Matrix](https://shields.private.coffee/badge/Matrix-join%20us!-blue?logo=matrix)](https://matrix.to/#/#structables:private.coffee)
+[![Matrix](https://shields.private.coffee/badge/Matrix-join%20us!-blue?logo=matrix)](https://matrix.pcof.fi/#/#structables:private.coffee)
 [![PyPI](https://shields.private.coffee/pypi/v/structables)](https://pypi.org/project/structables/)
 [![PyPI - Python Version](https://shields.private.coffee/pypi/pyversions/structables)](https://pypi.org/project/structables/)
 [![PyPI - License](https://shields.private.coffee/pypi/l/structables)](https://pypi.org/project/structables/)
@@ -697,6 +697,12 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 
 To add your own instance to this list, please open a pull request or issue.
 
+## Opening Issues
+
+If you're having problems using Structables, or if you have ideas or feedback for us, feel free to open an issue in the [Private.coffee Git](https://git.private.coffee/PrivateCoffee/structables/issues) or on [Github](https://github.com/PrivateCoffee/structables/issues).
+
+Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structables:private.coffee) to discuss your ideas with us.
+
 ## Run your own instance
 
 ### Production

{structables-0.2.1 → structables-0.3.0}/README.md

@@ -5,7 +5,7 @@
 An open source alternative front-end to Instructables. This is a fork of <a href="https://codeberg.org/indestructables/indestructables">snowcatridge10's Indestructables</a> to get rid of Selenium. Indestructables itself is a fork of <a href="https://git.vern.cc/cobra/Destructables">Cobra's Destructables</a>.
 
 [![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-support%20us!-pink?logo=coffeescript)](https://private.coffee)
-[![Matrix](https://shields.private.coffee/badge/Matrix-join%20us!-blue?logo=matrix)](https://matrix.to/#/#structables:private.coffee)
+[![Matrix](https://shields.private.coffee/badge/Matrix-join%20us!-blue?logo=matrix)](https://matrix.pcof.fi/#/#structables:private.coffee)
 [![PyPI](https://shields.private.coffee/pypi/v/structables)](https://pypi.org/project/structables/)
 [![PyPI - Python Version](https://shields.private.coffee/pypi/pyversions/structables)](https://pypi.org/project/structables/)
 [![PyPI - License](https://shields.private.coffee/pypi/l/structables)](https://pypi.org/project/structables/)
@@ -19,6 +19,12 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 
 To add your own instance to this list, please open a pull request or issue.
 
+## Opening Issues
+
+If you're having problems using Structables, or if you have ideas or feedback for us, feel free to open an issue in the [Private.coffee Git](https://git.private.coffee/PrivateCoffee/structables/issues) or on [Github](https://github.com/PrivateCoffee/structables/issues).
+
+Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structables:private.coffee) to discuss your ideas with us.
+
 ## Run your own instance
 
 ### Production

{structables-0.2.1 → structables-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "structables"
-version = "0.2.1"
+version = "0.3.0"
 authors = [
   { name="Private.coffee Team", email="support@private.coffee" },
 ]

structables-0.3.0/src/structables/config.py

@@ -0,0 +1,13 @@
+import os
+
+class Config:
+    DEBUG = os.environ.get("FLASK_DEBUG", os.environ.get("STRUCTABLES_DEBUG", False))
+    PORT = int(os.environ.get("STRUCTABLES_PORT", 8002))
+    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")
+
+    @staticmethod
+    def init_app(app):
+        pass

structables-0.3.0/src/structables/main.py

@@ -0,0 +1,20 @@
+#!/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)
+
+if __name__ == "__main__":
+    app.run(port=app.config['PORT'], host=app.config['LISTEN_HOST'], debug=app.config['DEBUG'])
+
+# Initialize data when the server starts
+update_data(app)

structables-0.3.0/src/structables/routes/__init__.py

@@ -0,0 +1,12 @@
+from .main import init_main_routes
+from .category import init_category_routes
+from .member import init_member_routes
+from .proxy import init_proxy_routes
+from .contest import init_contest_routes
+
+def init_routes(app):
+    init_main_routes(app)
+    init_category_routes(app)
+    init_member_routes(app)
+    init_proxy_routes(app)
+    init_contest_routes(app)

structables-0.3.0/src/structables/routes/category.py

@@ -0,0 +1,76 @@
+from flask import redirect
+from werkzeug.exceptions import NotFound
+from ..utils.helpers import project_list, category_page
+
+
+def init_category_routes(app):
+    @app.route("/<category>/<channel>/projects/")
+    def route_channel_projects(category, channel):
+        return project_list(app, channel.title())
+
+    @app.route("/<category>/<channel>/projects/<sort>/")
+    def route_channel_projects_sort(category, channel, sort):
+        return project_list(
+            app,
+            channel.title(),
+            " Sorted by " + sort.title(),
+        )
+
+    @app.route("/<category>/projects/")
+    def route_category_projects(category):
+        return project_list(app, category.title())
+
+    @app.route("/<category>/projects/<sort>/")
+    def route_category_projects_sort(category, sort):
+        return project_list(app, category.title(), " Sorted by " + sort.title())
+
+    @app.route("/projects/")
+    def route_projects():
+        return project_list(app, "")
+
+    @app.route("/projects/<sort>/")
+    def route_projects_sort(sort):
+        return project_list(app, "", " Sorted by " + sort.title())
+
+    @app.route("/circuits/")
+    def route_circuits():
+        return category_page(app, "Circuits")
+
+    @app.route("/workshop/")
+    def route_workshop():
+        return category_page(app, "Workshop")
+
+    @app.route("/craft/")
+    def route_craft():
+        return category_page(app, "Craft")
+
+    @app.route("/cooking/")
+    def route_cooking():
+        return category_page(app, "Cooking")
+
+    @app.route("/living/")
+    def route_living():
+        return category_page(app, "Living")
+
+    @app.route("/outside/")
+    def route_outside():
+        return category_page(app, "Outside")
+
+    @app.route("/teachers/")
+    def route_teachers():
+        return category_page(app, "Teachers", True)
+
+    @app.route("/<category>/<channel>/")
+    def route_channel_redirect(category, channel):
+        if (
+            category == "circuits"
+            or category == "workshop"
+            or category == "craft"
+            or category == "cooking"
+            or category == "living"
+            or category == "outside"
+            or category == "teachers"
+        ):
+            return redirect(f"/{category}/{channel}/projects/", 307)
+        else:
+            raise NotFound()

structables-0.3.0/src/structables/routes/contest.py

@@ -0,0 +1,177 @@
+from flask import render_template, request, abort
+from urllib.request import urlopen
+from urllib.error import HTTPError
+from ..utils.helpers import proxy
+from bs4 import BeautifulSoup
+
+def init_contest_routes(app):
+    @app.route("/contest/archive/")
+    def route_contest_archive():
+        page = 1
+        if request.args.get("page") is not None:
+            page = request.args.get("page")
+
+        try:
+            data = urlopen(f"https://www.instructables.com/contest/archive/?page={page}")
+        except HTTPError as e:
+            abort(e.code)
+
+        soup = BeautifulSoup(data.read().decode(), "html.parser")
+
+        main = soup.select("div#contest-archive-wrapper")[0]
+
+        contest_count = main.select("p.contest-count")[0].text
+
+        contest_list = []
+        for index, year in enumerate(main.select("div.contest-archive-list h2")):
+            year_list = main.select(
+                "div.contest-archive-list div.contest-archive-list-year"
+            )[index]
+            year_name = year.text
+            month_list = []
+            for month in year_list.select("div.contest-archive-list-month"):
+                month_name = month.select("h3")[0].text
+                month_contest_list = []
+                for p in month.select("p"):
+                    date = p.select("span")[0].text
+                    link = p.select("a")[0].get("href")
+                    title = p.select("a")[0].text
+                    month_contest_list.append([date, link, title])
+                month_list.append([month_name, month_contest_list])
+            contest_list.append([year_name, month_list])
+
+        pagination = main.select("nav.pagination ul.pagination")[0]
+
+        return render_template(
+            "archives.html",
+            title=f"Contest Archives (Page {page})",
+            page=page,
+            contest_count=contest_count,
+            pagination=pagination,
+            contest_list=contest_list,
+        )
+
+    @app.route("/contest/<contest>/")
+    def route_contest(contest):
+        try:
+            data = urlopen(f"https://www.instructables.com/contest/{contest}/")
+        except HTTPError as e:
+            abort(e.code)
+
+        soup = BeautifulSoup(data.read().decode(), "html.parser")
+
+        title = soup.select('meta[property="og:title"]')[0].get("content")
+
+        body = soup.select("div#contest-wrapper")[0]
+
+        img = proxy(body.select("div#contest-masthead img")[0].get("src"))
+
+        entry_count = body.select("li.entries-nav-btn")[0].text.split(" ")[0]
+        prizes = body.select("li.prizes-nav-btn")[0].text.split(" ")[0]
+
+        info = body.select("div.contest-body-column-left")[0]
+        info.select("div#site-announcements-page")[0].decompose()
+        info.select("h3")[0].decompose()
+        info.select("div#contest-body-nav")[0].decompose()
+        info = str(info).replace("https://www.instructables.com", "/")
+
+        body.select("span.contest-entity-count")[0].text
+
+        entry_list = []
+        for entry in body.select("div.contest-entries-list div.contest-entries-list-ible"):
+            link = entry.a["href"]
+            entry_img = proxy(entry.select("a noscript img")[0].get("src"))
+            entry_title = entry.select("a.ible-title")[0].text
+            author = entry.select("div span.ible-author a")[0].text
+        author_link = entry.select("div span.ible-author a")[0].get("href")
+        channel = entry.select("div span.ible-channel a")[0].text
+        channel_link = entry.select("div span.ible-channel a")[0].get("href")
+        views = entry.select(".ible-views")[0].text
+
+        entry_list.append(
+            {
+                "link": link,
+                "entry_img": entry_img,
+                "entry_title": entry_title,
+                "author": author,
+                "author_link": author_link,
+                "channel": channel,
+                "channel_link": channel_link,
+                "views": views,
+            }
+        )
+
+        return render_template(
+            "contest.html",
+            title=title,
+            img=img,
+            entry_count=entry_count,
+            prizes=prizes,
+            info=info,
+            entry_list=entry_list,
+        )
+
+    @app.route("/contest/")
+    def route_contests():
+        try:
+            data = urlopen("https://www.instructables.com/contest/")
+        except HTTPError as e:
+            abort(e.code)
+
+        soup = BeautifulSoup(data.read().decode(), "html.parser")
+
+        contest_count = str(soup.select("p.contest-count")[0])
+
+        contests = []
+        for contest in soup.select("div#cur-contests div.row-fluid div.contest-banner"):
+            link = contest.select("div.contest-banner-inner a")[0].get("href")
+            img = proxy(contest.select("div.contest-banner-inner a img")[0].get("src"))
+            alt = contest.select("div.contest-banner-inner a img")[0].get("alt")
+            deadline = contest.select("span.contest-meta-deadline")[0].get("data-deadline")
+            prizes = contest.select("span.contest-meta-count")[0].text
+            entries = contest.select("span.contest-meta-count")[1].text
+
+            contests.append(
+                {
+                    "link": link,
+                    "img": img,
+                    "alt": alt,
+                    "deadline": deadline,
+                    "prizes": prizes,
+                    "entries": entries,
+                }
+            )
+
+        closed = []
+        for display in soup.select("div.contest-winner-display"):
+            link = display.select("div.contest-banner-inner a")[0].get("href")
+            img = proxy(display.select("div.contest-banner-inner a img")[0].get("src"))
+            alt = display.select("div.contest-banner-inner a img")[0].get("alt")
+            featured_items = []
+            for featured_item in display.select("ul.featured-items li"):
+                item_link = featured_item.select("div.ible-thumb a")[0].get("href")
+                item_img = proxy(featured_item.select("div.ible-thumb a img")[0].get("src"))
+                item_title = featured_item.select("a.title")[0].text
+                item_author = featured_item.select("a.author")[0].text
+                item_author_link = featured_item.select("a.author")[0].get("href")
+
+                featured_items.append(
+                    {
+                        "link": item_link,
+                        "img": item_img,
+                        "title": item_title,
+                        "author": item_author,
+                        "author_link": item_author_link,
+                    }
+                )
+            closed.append(
+                {"link": link, "img": img, "alt": alt, "featured_items": featured_items}
+            )
+
+        return render_template(
+            "contests.html",
+            title="Contests",
+            contest_count=contest_count,
+            contests=contests,
+            closed=closed,
+        )