feat: made status page URL configurable and added description about l…

…ive instance rate limits (#97)

.env.dist

@@ -6,6 +6,7 @@ APP_PORT=80
 APP_BASE_URL=https://overfast-api.tekrop.fr
 LOG_LEVEL=info
 MAX_CONCURRENT_REQUESTS=5
+STATUS_PAGE_URL=
 
 # Redis
 REDIS_CACHING_ENABLED=true

README.md

@@ -24,6 +24,7 @@
 
 
 ## ✨ [Live instance](https://overfast-api.tekrop.fr)
+The live instance is restricted to **30 req/s** (a shared limit across all endpoints). If you require more, consider hosting your own instance on a server 👍
 
 - Live instance (Redoc documentation) : https://overfast-api.tekrop.fr/
 - Swagger UI : https://overfast-api.tekrop.fr/docs

app/config.py

@@ -40,6 +40,9 @@ class Settings(BaseSettings):
     # Max HTTPX concurrent requests for async calls to Blizzard (cache updates)
     max_concurrent_requests: int = 5
 
+    # Optional, status page URL if you have any to provide
+    status_page_url: str | None = None
+
     ############
     # REDIS CONFIGURATION
     ############

app/main.py

@@ -27,20 +27,23 @@ async def lifespan(_: FastAPI):  # pragma: no cover
 
 
 app = FastAPI(title="OverFast API", docs_url=None, redoc_url=None, lifespan=lifespan)
-description = f"""OverFast API gives data about Overwatch 2 heroes, gamemodes, maps and players
-statistics by scraping Blizzard pages. Built with **FastAPI** and **Beautiful Soup**, and uses
-**nginx** as reverse proxy and **Redis** for caching. By using a Refresh-Ahead cache system, it
-minimizes calls to Blizzard pages (which can be very slow), and quickly returns accurate
-data to users.
+description = f"""OverFast API provides comprehensive data on Overwatch 2 heroes,
+game modes, maps, and player statistics by scraping Blizzard pages. Developed with
+the efficiency of **FastAPI** and **Beautiful Soup**, it leverages **nginx** as a
+reverse proxy and **Redis** for caching. Its tailored caching mechanism significantly
+reduces calls to Blizzard pages, ensuring swift and precise data delivery to users.
 
-In players statistics endpoints, several conversions are made for convenience :
-- all **duration values** are converted into **seconds** (integer)
-- **percent values** are exposed as **integers** instead of a string with a percent symbol
-- integer and float string representations are converted into the concerned type
+This live instance is restricted to **30 req/s** (a shared limit across all endpoints).
+If you require more, consider hosting your own instance on a server 👍
+
+In player career statistics, various conversions are applied for ease of use:
+- **Duration values** are converted to **seconds** (integer)
+- **Percent values** are represented as **integers**, omitting the percent symbol
+- Integer and float string representations are converted to their respective types
 
 Swagger UI (useful for trying API calls) : {settings.app_base_url}/docs
 
-Status page : https://stats.uptimerobot.com/E0k0yU1pJQ
+{f"Status page : {settings.status_page_url}" if settings.status_page_url else ""}
 """
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "overfast-api"
-version = "2.25.1"
+version = "2.25.2"
 description = "Overwatch API giving data about heroes, maps, and players statistics."
 license = "MIT"
 authors = ["Valentin PORCHET <valentin.porchet@proton.me>"]