whatdidyoudo 0.1.10__tar.gz → 0.1.11__tar.gz

{whatdidyoudo-0.1.10 → whatdidyoudo-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: whatdidyoudo
-Version: 0.1.10
+Version: 0.1.11
 Summary: A minimal Flask app that shows the amount of OpenStreetMap changes made by a user on a day.
 Project-URL: Homepage, https://github.com/rompe/whatdidyoudo
 Project-URL: Issues, https://github.com/rompe/whatdidyoudo/issues

{whatdidyoudo-0.1.10 → whatdidyoudo-0.1.11}/whatdidyoudo/app.py

@@ -2,6 +2,7 @@
 import datetime
 import xml.etree.ElementTree as ET
 from collections import defaultdict
+from dataclasses import dataclass
 import requests
 
 from flask import Flask, render_template
@@ -9,7 +10,7 @@ from flask_caching import Cache
 from flask_limiter import Limiter
 from flask_limiter.util import get_remote_address
 
-__version__ = "0.1.10"
+__version__ = "0.1.11"
 
 app = Flask(__name__)
 cache = Cache(app, config={"CACHE_TYPE": "SimpleCache",
@@ -17,6 +18,13 @@ cache = Cache(app, config={"CACHE_TYPE": "SimpleCache",
 limiter = Limiter(app=app, key_func=get_remote_address)
 
 
+@dataclass
+class Changes:
+    """Represent changes made by a user."""
+    changes: int = 0
+    changesets: int = 0
+
+
 def get_etree_from_url(url: str) -> ET.Element:
     """Fetches XML content from a URL and returns the root Element."""
     response = requests.get(url, timeout=120)
@@ -24,10 +32,10 @@ def get_etree_from_url(url: str) -> ET.Element:
     return ET.fromstring(response.content)
 
 
-def get_changes(user: str, date: str):
-    """Return a {app: num of changes} dictionary and the changesets amount."""
-    changes: defaultdict[str, int] = defaultdict(int)
-    changesets = 0
+def get_changes(user: str, date: str) -> defaultdict[str, Changes]:
+    """Return a {app: Changes} dictionary."""
+    # {user: {app: Changes}}
+    changes: defaultdict[str, Changes] = defaultdict(Changes)
     datetime_date = datetime.date.fromisoformat(date)
     start_time = f"{datetime_date}T00:00:00Z"
     end_time = f"{datetime_date + datetime.timedelta(days=1)}T00:00:00Z"
@@ -41,7 +49,7 @@ def get_changes(user: str, date: str):
 
         tags = {tag.attrib["k"]: tag.attrib["v"] for tag in cs.findall("tag")}
         editor = tags.get("created_by", "")
-        changesets += 1
+        changes[editor].changesets += 1
 
         diff_url = ("https://api.openstreetmap.org/api/0.6/changeset/"
                     f"{cs_id}/download")
@@ -51,38 +59,41 @@ def get_changes(user: str, date: str):
             continue
 
         for action in root:
-            changes[editor] += len(action)
-    return changes, changesets
+            changes[editor].changes += len(action)
+    return changes
 
 
 @app.route('/')
+@app.route('/<user>/')
 @app.route('/<user>')
 @app.route('/<user>/<date>')
 def whatdidyoudo(user: str | None = None, date: str | None = None) -> str:
     """shows OSM tasks done by a user on a specific day."""
-    changes: defaultdict[str, int] = defaultdict(int)
-    changesets = 0
-    error = ""
-    if user and date:
-        try:
-            today = datetime.date.today().isoformat()
-            if date != today:
-                cache_key = f"changes_{user}_{date}"
-                cached = cache.get(cache_key)  # type: ignore
-                if cached:
-                    changes, changesets = cached
-                else:
-                    with limiter.limit("10 per minute"):
-                        changes, changesets = get_changes(user, date)
-                    cache.set(cache_key, (changes, changesets))  # type: ignore
-            else:
+    changes: defaultdict[str, defaultdict[str, Changes]] = \
+        defaultdict(lambda: defaultdict(Changes))
+    changesets: dict[str, int] = {}
+    errors: list[str] = []
+    today = datetime.date.today().isoformat()
+    if not date:
+        date = today
+    for name in [item.strip() for item in (user or "").split(",")
+                 if item.strip()]:
+        cache_key = f"changes_{name}_{date}"
+        cur_changes = cache.get(cache_key)  # type: ignore
+        if not cur_changes:
+            try:
                 with limiter.limit("10 per minute"):
-                    changes, changesets = get_changes(user, date)
-        except requests.HTTPError:
-            error = f"Can't determine changes for user {user} on {date}."
+                    cur_changes = get_changes(name, date)
+                if date != today:
+                    cache.set(cache_key, cur_changes)  # type: ignore
+            except requests.HTTPError:
+                errors.append(
+                    f"Can't determine changes for user {name} on {date}.")
+        if cur_changes:
+            changes[name] = cur_changes
 
     return render_template('form.html', user=user, date=date, changes=changes,
-                           changesets=changesets, error=error,
+                           changesets=changesets, errors=errors,
                            version=__version__)
 
 

{whatdidyoudo-0.1.10 → whatdidyoudo-0.1.11}/whatdidyoudo/static/style.css

@@ -96,6 +96,11 @@ a:hover {
     text-decoration: underline;
 }
 
+.note {
+    font-size: 0.9em;
+    color: #aaa;
+    margin-top: 1.5em;
+}
 .disclaimer {
     font-size: 0.9em;
     color: #777;

{whatdidyoudo-0.1.10 → whatdidyoudo-0.1.11}/whatdidyoudo/templates/form.html

@@ -31,18 +31,27 @@
             <button type="submit">Show</button>
         </form>
     {% if user and date %}
-        {% if error %}
+        {% for error in errors %}
             <p class=error>{{ error }}</p>
-        {% elif changes %}
-            <p><a href="https://www.openstreetmap.org/user/{{ user }}">{{ user }}</a> did {{ changes.values() | sum }} changes in {{ changesets }} changeset{{ "s" if changesets > 1 else ""  }} on {{ date }}:</p>
+        {% endfor %}
+        {% for name, apps in changes.items() %}
+            {% set ns = namespace(changes=0, changesets=0) %}
+            {% for Change in apps.values() %}
+                {% set ns.changes = ns.changes + Change.changes %}
+                {% set ns.changesets = ns.changesets + Change.changesets %}
+            {% endfor %}
             <ul>
-            {% for app, count in changes.items() %}
-                <li>{{ count }} changes in {{ app }}</li>
+            <p><a href="https://www.openstreetmap.org/user/{{ user }}">{{ name }}</a>
+                 did {{ ns.changes }} change{{ "s" if ns.changes > 1 else ""  }}
+                 in {{ ns.changesets }} changeset{{ "s" if ns.changesets > 1 else ""  }}
+                 on {{ date }}:</p>
+            {% for app, Change in apps.items() %}
+                <li>{{ Change.changes }} change{{ "s" if Change.changes > 1 else ""  }} in
+                    {{ Change.changesets }} changeset{{ "s" if Change.changesets > 1 else ""  }}
+                    with {{ app }}</li>
             {% endfor %}
             </ul>
-        {% else %}
-            <p><a href="https://www.openstreetmap.org/user/{{ user }}">{{ user }}</a> did not do anything on {{ date }}.</p>
-        {% endif %}
+        {% endfor %}
     {% else %}
         <p>
             How much did you contribute to <a href="https://www.openstreetmap.org/">OpenStreetMap</a> today? Or any other day?
@@ -50,6 +59,15 @@
         <p>
             To answer this question, enter your OSM username and the date you want to check above and click "Show".
         </p>
+        <div class="note">
+            <h4>Tips</h4>
+            <ul>
+                <li>Do you want to have a bookmark that always shows your numbers for the current day?
+                    Just use <code>/YOUR_USERNAME</code> as URL and omit the date!</li>
+                <li>You can enter multiple usernames separated by commas to see their contributions at once.
+                    Try this after a mapwalk with friends!</li>
+            </ul>
+        </div>
         <div class="disclaimer">
             <h4>Disclaimers</h4>
             <ul>