initial commit

pypistats/views/api.py

@@ -0,0 +1,133 @@
+"""JSON API routes."""
+from flask import abort
+from flask import Blueprint
+from flask import jsonify
+from flask import request
+
+from pypistats.models.download import OverallDownloadCount
+from pypistats.models.download import PythonMajorDownloadCount
+from pypistats.models.download import PythonMinorDownloadCount
+from pypistats.models.download import RecentDownloadCount
+from pypistats.models.download import SystemDownloadCount
+
+
+blueprint = Blueprint('api', __name__, url_prefix='/api')
+
+
+@blueprint.route("/<package>/recent")
+def api_downloads_recent(package):
+    """Get the recent downloads of a package."""
+    category = request.args.get('period')
+    if category is None:
+        downloads = RecentDownloadCount.query.filter_by(package=package).all()
+    elif category in ("day", "week", "month"):
+        downloads = RecentDownloadCount.query.filter_by(package=package, category=category).first()
+    else:
+        abort(404)
+
+    response = {"package": package, "type": "recent_downloads"}
+    if len(downloads) > 0:
+        response["data"] = {
+            r.category: r.downloads for r in downloads
+        }
+    else:
+        abort(404)
+
+    return jsonify(response)
+
+
+@blueprint.route("/<package>/overall")
+def api_downloads_overall(package):
+    """Get the overall download time series of a package."""
+    mirrors = request.args.get('mirrors')
+    if mirrors == 'true':
+        downloads = OverallDownloadCount.query.\
+            filter_by(package=package, category="with_mirrors").\
+            order_by(OverallDownloadCount.date).all()
+    elif mirrors == 'false':
+        downloads = OverallDownloadCount.query.\
+            filter_by(package=package, category="without_mirrors").\
+            order_by(OverallDownloadCount.date).all()
+    else:
+        downloads = OverallDownloadCount.query.\
+            filter_by(package=package).\
+            order_by(OverallDownloadCount.category, OverallDownloadCount.date).all()
+
+    response = {"package": package, "type": "overall_downloads"}
+    if len(downloads) > 0:
+        response["data"] = [{
+            "date": str(r.date),
+            "category": r.category,
+            "downloads": r.downloads,
+        } for r in downloads]
+    else:
+        abort(404)
+
+    return jsonify(response)
+
+
+@blueprint.route("/<package>/python_major")
+def api_downloads_python_major(package):
+    """Get the python major download time series of a package."""
+    return generic_downloads(PythonMajorDownloadCount, package, "version", "python_major")
+
+
+@blueprint.route("/<package>/python_minor")
+def api_downloads_python_minor(package):
+    """Get the python minor download time series of a package."""
+    return generic_downloads(PythonMinorDownloadCount, package, "version", "python_minor")
+
+
+@blueprint.route("/<package>/system")
+def api_downloads_system(package):
+    """Get the system download time series of a package."""
+    return generic_downloads(SystemDownloadCount, package, "os", "system")
+
+
+def generic_downloads(model, package, arg, name):
+    """Generate a generic response."""
+    category = request.args.get(f"{arg}")
+    if category is not None:
+        downloads = model.query.\
+            filter_by(package=package, category=category).\
+            order_by(model.date).all()
+    else:
+        downloads = model.query.\
+            filter_by(package=package).\
+            order_by(model.category, model.date).all()
+
+    response = {"package": package, "type": f"{name}_downloads"}
+    if downloads is not None:
+        response["data"] = [{
+            "date": str(r.date),
+            "category": r.category,
+            "downloads": r.downloads,
+        } for r in downloads]
+    else:
+        abort(404)
+
+    return jsonify(response)
+
+
+@blueprint.route("/top/overall")
+def api_top_packages():
+    """Get the most downloaded packages by recency."""
+    return "top overall"
+
+
+@blueprint.route("/top/python_major")
+def api_top_python_major():
+    """Get the most downloaded packages by python major version."""
+    return "top python_major"
+
+
+@blueprint.route("/top/python_minor")
+def api_top_python_minor():
+    """Get the most downloaded packages by python minor version."""
+    return "top python_minor"
+
+
+@blueprint.route("/top/system")
+def api_top_system():
+    """Get the most downloaded packages by system."""
+    return "top python_minor"