structables 0.3.12__tar.gz → 0.3.13__tar.gz

{structables-0.3.12 → structables-0.3.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structables
-Version: 0.3.12
+Version: 0.3.13
 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

{structables-0.3.12 → structables-0.3.13}/pyproject.toml

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

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

@@ -0,0 +1,174 @@
+from flask import render_template, request, abort, url_for
+from urllib.request import urlopen, Request
+from urllib.error import HTTPError
+from ..utils.helpers import proxy
+from bs4 import BeautifulSoup
+import json
+
+
+def init_contest_routes(app):
+    @app.route("/contest/archive/")
+    def route_contest_archive():
+        # Default pagination settings
+        limit = 10
+        page = request.args.get("page", default=1, type=int)
+        offset = (page - 1) * limit
+
+        try:
+            # Fetch data using urlopen
+            url = f"https://www.instructables.com/json-api/getClosedContests?limit={limit}&offset={offset}"
+            response = urlopen(url)
+            data = json.loads(response.read().decode())
+        except HTTPError as e:
+            abort(e.code)
+        except Exception as e:
+            abort(500)  # Handle other exceptions like JSON decode errors
+
+        contests = data.get("contests", [])
+        full_list_size = data.get("fullListSize", 0)
+
+        contest_list = []
+        for contest in contests:
+            contest_details = {
+                "title": contest["title"],
+                "link": url_for("route_contest", contest=contest["urlString"]),
+                "deadline": contest["deadline"],
+                "startDate": contest["startDate"],
+                "numEntries": contest["numEntries"],
+                "state": contest["state"],
+                "bannerUrl": proxy(contest["bannerUrlMedium"]),
+            }
+            contest_list.append(contest_details)
+
+        # Calculate total pages
+        total_pages = (full_list_size + limit - 1) // limit
+
+        # Create pagination
+        pagination = {
+            "current_page": page,
+            "total_pages": total_pages,
+            "has_prev": page > 1,
+            "has_next": page < total_pages,
+            "limit": limit,
+        }
+
+        return render_template(
+            "archives.html",
+            title=f"Contest Archives (Page {page})",
+            page=page,
+            pagination=pagination,
+            contest_list=contest_list,
+        )
+
+    def get_entries(contest):
+        base_url = f"https://www.instructables.com/api_proxy/search/collections/projects/documents/search"
+        headers = {"x-typesense-api-key": app.typesense_api_key}
+        page, per_page = 1, 100
+        all_entries = []
+
+        while True:
+            try:
+                url = f"{base_url}?q=*&filter_by=contestPath:{contest}&sort_by=contestEntryDate:desc&per_page={per_page}&page={page}"
+                request = Request(url, headers=headers)
+                response = urlopen(request)
+                data = json.loads(response.read().decode())
+            except HTTPError as e:
+                abort(e.code)
+
+            hits = data.get("hits", [])
+            if not hits:
+                break
+
+            all_entries.extend(hits)
+            if len(hits) < per_page:
+                break
+            page += 1
+
+        return all_entries
+
+    @app.route("/contest/<contest>/")
+    def route_contest(contest):
+        try:
+            data = urlopen(f"https://www.instructables.com/contest/{contest}/")
+            html = data.read().decode()
+            soup = BeautifulSoup(html, "html.parser")
+
+            title_tag = soup.find("h1")
+            title = title_tag.get_text() if title_tag else "Contest"
+
+            img_tag = soup.find("img", alt=lambda x: x and "Banner" in x)
+            img = img_tag.get("src") if img_tag else "default.jpg"
+
+            entry_count = len(get_entries(contest))
+            prizes_items = soup.select("article")
+            prizes = len(prizes_items) if prizes_items else 0
+
+            overview_section = soup.find("section", id="overview")
+            info = (
+                overview_section.decode_contents()
+                if overview_section
+                else "No Overview"
+            )
+
+        except HTTPError as e:
+            abort(e.code)
+
+        entry_list = []
+        entries = get_entries(contest)
+        for entry in entries:
+            doc = entry["document"]
+            entry_details = {
+                "link": url_for("route_article", article=doc["urlString"]),
+                "entry_img": doc["coverImageUrl"],
+                "entry_title": doc["title"],
+                "author": doc["screenName"],
+                "author_link": url_for("route_member", member=doc["screenName"]),
+                "channel": doc["channel"][0],
+                "channel_link": f"/{doc['primaryClassification']}",
+                "views": doc.get("views", 0),
+            }
+            entry_list.append(entry_details)
+
+        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:
+            # Fetch current contests from the JSON API
+            response = urlopen(
+                "https://www.instructables.com/json-api/getCurrentContests?limit=50&offset=0"
+            )
+            data = json.loads(response.read().decode())
+        except HTTPError as e:
+            abort(e.code)
+        except Exception as e:
+            abort(500)  # Handle other exceptions such as JSON decode errors
+
+        contests = data.get("contests", [])
+        contest_list = []
+        for contest in contests:
+            contest_details = {
+                "link": url_for("route_contest", contest=contest["urlString"]),
+                "img": proxy(contest["bannerUrlMedium"]),
+                "alt": contest["title"],
+                "title": contest["title"],
+                "deadline": contest["deadline"],
+                "prizes": contest["prizeCount"],
+                "entries": contest["numEntries"],
+            }
+            contest_list.append(contest_details)
+
+        return render_template(
+            "contests.html",
+            title="Contests",
+            contest_count=len(contest_list),
+            contests=contest_list,
+        )

{structables-0.3.12 → structables-0.3.13}/src/structables/static/css/style.css

@@ -130,144 +130,67 @@ blockquote {
   }
 }
 
-.ibles {
-  display: inline-block;
-  vertical-align: top;
-}
-
-.ible-small {
-  font-size: 0.7em;
-  font-weight: thin;
-  line-height: 1em;
-}
-
-.step-section {
-  background-color: var(--primary-bg);
-  border: 1px solid var(--border-color);
-  border-radius: 8px;
-  box-shadow: 0 2px 4px var(--shadow-color);
-  padding: 1.5rem;
-}
-
-.step-header h2 {
-  font-size: 2em;
-  color: var(--heading-color);
-}
-
-.step-images img,
-.step-videos video,
-.step-iframes iframe {
-  border-radius: 8px;
-  box-shadow: 0 2px 4px var(--shadow-color);
-}
-
-.step-text {
-  font-size: 1.1em;
-}
-
-.reply-button,
-.replies {
-  display: none;
-}
-
-.reply-button+label {
-  position: relative;
-  display: block;
-  cursor: pointer;
-}
-
-input.reply-button:checked+label+.replies {
+.contest-list {
   display: flex;
   flex-direction: column;
-  gap: 1rem;
-  margin-top: 1rem;
+  gap: 20px;
 }
 
-.member-list {
-  display: inline-block;
-  max-width: 200px;
-  vertical-align: top;
-}
-
-.ible-list-item {
-  display: inline-block;
-  max-width: 350px;
-  vertical-align: top;
-  margin-bottom: 2rem;
-}
-
-.contest-list-item {
-  display: inline-block;
-  max-width: 500px;
-  vertical-align: top;
-  margin-bottom: 2rem;
+.contest-item {
+  background-color: #fff;
+  padding: 20px;
+  border: 1px solid var(--border-color);
+  border-radius: 8px;
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
 }
 
-.archive-month-wrapper {
-  display: inline-block;
-  width: 30vw;
-  vertical-align: top;
+.contest-item img {
+  max-width: 100%;
+  height: auto;
+  border-radius: 4px;
+  margin-top: 10px;
 }
 
-.archive-month {
+.pagination {
   display: flex;
-  flex-direction: column;
-  gap: -10px;
-  margin-bottom: 1rem;
-  justify-content: space-between;
-}
-
-.archive {
-  margin-bottom: -20px;
+  justify-content: center;
+  padding: 10px 0;
+  list-style-type: none;
 }
 
-ul.pagination {
+.pagination-list {
   display: flex;
-  justify-content: space-around;
-  padding: 0 33vw;
-  list-style-type: none;
   align-items: center;
+  gap: 10px;
 }
 
-ul.pagination li.active a,
-ul.pagination li.disabled a,
-ul.pagination li.active a:hover,
-ul.pagination li.disabled a:hover {
-  color: #bbc2cf;
-  text-decoration: none;
+.pagination-list li {
+  display: inline-block;
 }
 
-.closed-contest-contest {
-  object-fit: cover;
-  width: 33vw;
-  height: 15vw;
-  display: inline-block;
-  vertical-align: top;
-  padding: 0 10px;
+.pagination-list a {
+  color: var(--main-color);
+  text-decoration: none;
+  padding: 5px 10px;
+  border-radius: 4px;
+  border: 1px solid transparent;
+  transition: all 0.3s ease;
 }
 
-.closed-contest-winner,
-.closed-contest-winner-img {
-  width: 15vw;
-  display: inline-block;
-  vertical-align: top;
-  padding: 0 10px;
-  font-size: 0.8em;
-  text-overflow: ellipsis;
-  white-space: nowrap;
-  overflow: hidden;
+.pagination-list a:hover {
+  border-color: var(--link-color);
+  color: var(--link-color);
 }
 
-.sitemap-group {
-  margin-top: 2em;
-  display: inline-block;
-  width: 30vw;
-  text-align: left;
-  vertical-align: top;
+.pagination-list li.active a {
+  background-color: var(--link-color);
+  color: #fff;
+  border-color: var(--link-color);
 }
 
-.sitemap-group h2 {
-  text-align: center;
+.pagination-list li.disabled a {
+  color: #ccc;
+  cursor: not-allowed;
 }
 
 .container {
@@ -280,7 +203,6 @@ header {
 
 .go_here_link {
   background-color: #4caf50;
-  /* Green */
   border: none;
   color: white;
   padding: 15px 32px;
@@ -299,10 +221,6 @@ header {
   overflow-wrap: break-word;
 }
 
-.navbar-logo {
-  height: 64px;
-}
-
 .img-fluid {
   border-radius: 8px;
   box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
@@ -322,7 +240,17 @@ iframe {
   color: #6c757d !important;
 }
 
+.sitemap-group {
+  margin-top: 2em;
+  display: inline-block;
+  width: 30vw;
+  text-align: left;
+  vertical-align: top;
+}
 
+.sitemap-group h2 {
+  text-align: center;
+}
 
 .sitemap-group .card {
   background-color: var(--primary-bg);

structables-0.3.13/src/structables/templates/archives.html

@@ -0,0 +1,38 @@
+{% extends "base.html" %}
+
+{% block content %}
+    <center>
+        <h1>Past Contests</h1>
+        <p>Total Contests: {{ pagination.total_pages * pagination.limit }}</p>
+        <p><a href="/contest/">See running contests</a></p>
+    </center>
+    <div class="contest-list">
+        {% for contest in contest_list %}
+            <div class="contest-item">
+                <hr>
+                <h2>{{ contest.title }}</h2>
+                <p>
+                    <a href="{{ contest.link }}">{{ contest.title }}</a><br>
+                    Start Date: {{ contest.startDate }}<br>
+                    Deadline: {{ contest.deadline }}<br>
+                    Entries: {{ contest.numEntries }}<br>
+                    Status: {{ contest.state }}<br>
+                </p>
+                <img src="{{ contest.bannerUrl }}" alt="{{ contest.title }} banner" style="max-width:100%;">
+                <hr>
+            </div>
+        {% endfor %}
+    </div>
+    <hr>
+    <div class="pagination">
+        <ul class="pagination-list">
+            {% if pagination.has_prev %}
+                <li><a href="?page={{ pagination.current_page - 1 }}">Previous</a></li>
+            {% endif %}
+            <li>Page {{ pagination.current_page }} of {{ pagination.total_pages }}</li>
+            {% if pagination.has_next %}
+                <li><a href="?page={{ pagination.current_page + 1 }}">Next</a></li>
+            {% endif %}
+        </ul>
+    </div>
+{% endblock %}

structables-0.3.13/src/structables/templates/contest.html

@@ -0,0 +1,23 @@
+{% extends "base.html" %}
+
+{% block content %}
+    <center>
+        <h1>{{ title }}</h1>
+        <img src="{{ img }}" alt="{{ title }}" style="max-width:98vw;">
+        <p>{{ entry_count }} Entries, {{ prizes }} Prizes</p>
+        <br>
+        {{ info|safe }}
+        <div class="ible-list">
+            {% for ible in entry_list %}
+            <div class="ible-list-item">
+                <a href="{{ ible.link }}" style="color:#bbc2cf;">
+                    <img style="max-width:350px;" src="{{ ible.entry_img }}" alt="{{ ible.entry_title }}">
+                    <p>{{ ible.entry_title }}</p>
+                </a>
+                <p>by <a href="{{ ible.author_link }}">{{ ible.author }}</a> in <a href="{{ ible.channel_link }}">{{ ible.channel }}</a></p>
+                <p>{{ ible.views }} Views</p>
+            </div>
+            {% endfor %}
+        </div>
+    </center>
+{% endblock %}

structables-0.3.13/src/structables/templates/contests.html

@@ -0,0 +1,21 @@
+{% extends "base.html" %}
+
+{% block content %}
+    <center>
+        <h1>{{ title }}</h1>
+        <p>Total Running Contests: {{ contest_count }}</p>
+        <br>
+        <div class="contest-list">
+            {% for contest in contests %}
+            <div class="contest-list-item">
+                <a href="{{ contest.link }}">
+                    <img src="{{ contest.img }}" alt="{{ contest.alt }}">
+                </a>
+                <h2>{{ contest.title }}</h2>
+                <p>Closes: {{ contest.deadline }}</p>
+                <p class="ible-small">{{ contest.prizes }} Prizes, {{ contest.entries }} Entries</p>
+            </div>
+            {% endfor %}
+        </div>
+    </center>
+{% endblock %}

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

@@ -1,177 +0,0 @@
-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,
-        )

structables-0.3.12/src/structables/templates/archives.html

@@ -1,31 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-	<center>
-		<h1>Past Contests</h1>
-		<p>{{ contest_count }}</p>
-		<p><a href="/contest/">See running contests</a></p>
-	</center>
-	{% for year in contest_list %}
-	<div class="archive-year">
-		<hr>
-		<h2>{{ year[0] }}</h2>
-		<hr>
-		{% for month in year[1] %}
-		<div class="archive-month-wrapper">
-			<div class="archive-month">
-				<h3>{{ month[0] }}</h3>
-				{% for contest in month[1] %}
-				<div class="archive">
-					<p>{{ contest[0] }}<a href="{{ contest[1] }}">{{ contest[2] }}</a></p>
-				</div>
-				{% endfor %}
-			</div>
-		</div>
-		{% endfor %}
-		<br>
-	</div>
-	{% endfor %}
-	<hr>
-	{{ pagination|safe }}
-{% endblock %}

structables-0.3.12/src/structables/templates/contest.html

@@ -1,23 +0,0 @@
-
-{% extends "base.html" %}
-
-{% block content %}
-	<center>
-		<img src="{{ img }}" alt="{{ title }}" style="max-width:98vw;">
-		<p>{{ entry_count }} Entries, {{ prizes }} Prizes</p>
-		<br>
-		{{ info|safe }}
-		<div class="ible-list">
-			{% for ible in entries %}
-			<div class="ible-list-item">
-				<a href="{{ ible.link }}" style="color:#bbc2cf;">
-					<img style="max-width:350px;" src="{{ ible.entry_img }}" alt="{{ ible.entry_title }}">
-					<p>{{ ible.entry_title }}</p>
-				</a>
-				<p>by <a href="{{ ible.author_link }}">{{ ible.author }}</a> in <a href="{{ ible.channel_link }}">{{ ible.channel }}</a></p>
-				<p>{{ ible.views }} Views</p>
-			</div>
-			{% endfor %}
-		</div>
-	</center>
-{% endblock %}

structables-0.3.12/src/structables/templates/contests.html

@@ -1,40 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-	<center>
-		<h1>{{ title }}</h1>
-		{{ contest_count|safe }}
-		<br>
-		<div class="contest-list">
-			{% for contest in contests %}
-			<div class="contest-list-item">
-				<a href="{{ contest.link }}">
-					<img src="{{ contest.img }}" alt="{{ contest.alt }}" style="max-width:500px;">
-				</a>
-				<p>Closes {{ contest.deadline }}</p>
-				<p class="ible-small">{{ contest.prizes }} Prizes, {{ contest.entries }} Entries</p>
-			</div>
-			{% endfor %}
-		</div>
-		<div class="closed-contests" id="contest-winners">
-			<h2>Winner's Circle</h2>
-			{% for closed in closed %}
-			<div class="closed-contest">
-				<a href="{{ closed.link }}"><img class="closed-contest-contest" src="{{ closed.img }}"
-						alt="{{ closed.alt }}"></a>
-				{% for featured_items in closed.featured_items %}
-				<div class="closed-contest-winner">
-					<a href="{{ featured_items.link }}">
-						<img class="closed-contest-winner-img" src="{{ featured_items.img }}"
-							alt="{{ featured_items.title}}">
-						<br>
-						<b>{{ featured_items.title }}</b>
-					</a>
-					<p>by <a href="{{ featured_items.author_link }}">{{ featured_items.author }}</a></p>
-				</div>
-				{% endfor %}
-			</div>
-			{% endfor %}
-		</div>
-	</center>
-{% endblock %}